首页 云数据库 Redis API参考 API目录 网络安全 DescribeInstanceSSL - 查询是否开启TLS(SSL)加密

DescribeInstanceSSL - 查询是否开启TLS(SSL)加密

查询实例是否开启了TLS(SSL)加密认证。

接口说明

Redis 2.8标准版、集群版实例和Redis 4.0集群版实例支持SSL加密。您可以启用SSL(Secure Socket Layer)加密,提高数据传输的安全性。

您可以在以下方法中任选其一来开启或关闭Redis实例的SSL加密功能,或者更新证书的有效期:

说明开启SSL加密会增加实例的网络响应时间。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeInstanceSSLREAD
  • Redis
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

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

实例ID。

r-bp1zxszhcgatnx****

返回参数

名称类型描述示例值
object
InstanceIdstring

实例ID。

r-bp1zxszhcgatnx****
RequestIdstring

请求ID。

02260F96-913E-4655-9BA5-A3651CAF****
SSLEnabledstring

SSL加密功能的状态:

  • Enable:已开启。
  • Disable:未开启。
Enable
SSLExpiredTimestring

SSL证书的过期时间。

2020-08-05T09:05:53Z
CertCommonNamestring

SSL证书的公共名,一般为需要申请SSL证书的域名。默认值为Redis实例的内网连接地址。

r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com

示例

正常返回示例

JSON格式

{
  "InstanceId": "r-bp1zxszhcgatnx****",
  "RequestId": "02260F96-913E-4655-9BA5-A3651CAF****",
  "SSLEnabled": "Enable",
  "SSLExpiredTime": "2020-08-05T09:05:53Z",
  "CertCommonName": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
  "CertDownloadURL": ""
}

错误码

HTTP status code错误码错误信息描述
400InvalidRedisVersionPatternRedis db or proxy version does not match specified pattern.Redis的db分片或者proxy分片的版本不匹配
403IncorrectCharacterTypeCurrent DB instance CharacterType does not support this operation.-
403IncorrectEngineVersionCurrent engine version does not support operations.当前引擎的小版本过低,不支持此操作,请升级小版本后重试

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

变更历史

变更时间变更内容概要操作
2023-04-11OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
出参OpenAPI 返回结构发生变更
阿里云首页 云数据库 Redis 版 相关技术圈