查询实例SSL信息
功能介绍
查询实例SSL信息。该接口目前仅针对Redis 6.0/7.0版本实例。
URI
GET /v2/{project_id}/instances/{instance_id}/ssl
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释： 项目ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| instance_id | 是 | String | 参数解释： 实例ID。可通过DCS控制台进入实例详情界面查看。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| enabled | Boolean | 参数解释： 只有当实例开启了SSL时，返回该参数。 取值范围： true：实例已经开启了SSL。 |
| ip | String | 参数解释： SSL连接的IPv4地址。 取值范围： 不涉及。 |
| ipv6 | String | 参数解释： SSL连接的IPv6地址。 取值范围： 不涉及。 |
| port | String | 参数解释： SSL连接端口。 取值范围： 不涉及。 |
| domain_name | String | 参数解释： SSL连接域名。 取值范围： 不涉及。 |
| ssl_expired_at | String | 参数解释： SSL证书有效期（UTC时间）。 取值范围： 不涉及。 |
| ssl_validated | Boolean | 参数解释： SSL证书是否有效。 取值范围： true：证书有效。 false：证书不可用。 |
状态码：204
参数解释：
无ssl信息。
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 参数解释： 错误信息。 取值范围： 不涉及。 |
| error_code | String | 参数解释： 错误码。 取值范围： 请参见错误码。 |
| error_ext_msg | String | 参数解释： 扩展错误信息（暂未使用，赋值为null）。 取值范围： 不涉及。 |
状态码：500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 参数解释： 错误信息。 取值范围： 不涉及。 |
| error_code | String | 参数解释： 错误码。 取值范围： 请参见错误码。 |
| error_ext_msg | String | 参数解释： 扩展错误信息（暂未使用，赋值为null）。 取值范围： 不涉及。 |
请求示例
GET https://{dcs_endpoint}/v2/{project_id}/instances/{instance_id}/ssl 响应示例
状态码：200
参数解释：
查询实例SSL信息成功。
{
"enabled" : true,
"ip" : "192.168.0.5",
"ipv6" : "::1",
"port" : "6379",
"domain_name" : "redis-553a2516-b865-4159-b774-204dc0a36e37.dcs.example.com:6379",
"ssl_expired_at" : "2022-06-15T02:21:18.669Z",
"ssl_validated" : true
} 状态码：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信息成功。 |
| 204 | 参数解释： 无ssl信息。 |
| 400 | 参数解释： 非法请求。 |
| 500 | 参数解释： 内部服务错误。 |
错误码
请参见错误码。
