调用DescribeInstanceSSL查询Redis实例是否开启了SSL加密认证。
Redis 2.8标准版、集群版实例和Redis 4.0集群版实例支持SSL加密。您可以启用SSL(Secure Socket Layer)加密,提高数据传输的安全性。
您可以在以下方法中任选其一来开启或关闭Redis实例的SSL加密功能,或者更新证书的有效期:
- 调用ModifyInstanceSSL。
- 在Redis控制台设置,操作步骤请参见设置SSL加密。
说明 开启SSL加密会增加实例的网络响应时间。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeInstanceSSL |
系统规定参数,取值:DescribeInstanceSSL。 |
InstanceId | String | 是 | r-bp1zxszhcgatnx**** |
实例ID。 |
RegionId | String | 否 | cn-hangzhou |
实例所属的地域ID。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
SSLEnabled | String | Enable |
SSL加密功能的状态:
|
SSLExpiredTime | String | 2020-08-05T09:05:53Z |
SSL证书的过期时间。 |
InstanceId | String | r-bp1zxszhcgatnx**** |
实例ID。 |
RequestId | String | 02260F96-913E-4655-9BA5-A3651CAF**** |
请求ID。 |
CertCommonName | String | r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com |
SSL证书的公共名,一般为需要申请SSL证书的域名。默认值为Redis实例的内网连接地址。 |
示例
请求示例
https://r-kvstore.aliyuncs.com/?Action=DescribeInstanceSSL
&InstanceId=r-bp1zxszhcgatnx****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeInstanceSSLResponse>
<SSLEnabled>Enable</SSLEnabled>
<SSLExpiredTime>2020-08-05T09:05:53Z</SSLExpiredTime>
<InstanceId>r-bp1zxszhcgatnx****</InstanceId>
<RequestId>02260F96-913E-4655-9BA5-A3651CAF****</RequestId>
<CertCommonName>r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com</CertCommonName>
</DescribeInstanceSSLResponse>
JSON
格式
{
"SSLEnabled": "Enable",
"SSLExpiredTime": "2020-08-05T09:05:53Z",
"InstanceId": "r-bp1zxszhcgatnx****",
"RequestId": "02260F96-913E-4655-9BA5-A3651CAF****",
"CertCommonName": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com"
}
错误码
访问错误中心查看更多错误码。