查询SSL状态

最近更新时间:2024-03-12 01:45:14

我的收藏

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

本接口(DescribeSSLStatus)用于查询实例 SSL 认证相关信息,包括开启状态、配置状态、证书地址等。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeSSLStatus。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例 ID。
示例值:crs-deindi7de

3. 输出参数

参数名称 类型 描述
CertDownloadUrl String SSL 证书下载地址。
示例值:https://
UrlExpiredTime String 证书下载链接到期时间。
示例值:2022-05-31 10:47:29
SSLConfig Boolean 标识实例开启 SSL 功能。
- true:开启 。
- false:关闭。
示例值:false
FeatureSupport Boolean 标识实例是否支持 SSL特性。
- true:支持。
- false:不支持。
示例值:false
Status Integer 说明配置 SSL 的状态。
- 1: 配置中。
- 2:配置成功。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

查询实例 SSL 认证信息

输入示例

https://redis.tencentcloudapi.com/?Action=DescribeSSLStatus
&InstanceId=crs-2btr9ryn
&<公共请求参数>

输出示例

{
    "Response": {
        "CertDownloadUrl": "abc",
        "UrlExpiredTime": "abc",
        "SSLConfig": true,
        "FeatureSupport": true,
        "Status": 0,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ActionNotFound 没有找到对应接口。
InvalidParameter.PermissionDenied 接口没有cam权限。
InvalidParameterValue.UnSupportedType 实例类型不支持。
ResourceNotFound.InstanceNotExists 根据 serialId 没有找到对应 redis。
ResourceUnavailable.InstanceStatusError 实例状态异常,不能执行对应操作。