云数据库 MySQL 查询 SSL 开通情况

接口请求域名: cdb.tencentcloudapi.com 。本接口(DescribeSSLStatus)用于查询 SSL 开通情况。如果已经开通 SSL ,会同步返回证书下载链接。

相关产品
云数据库 MySQL 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

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

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

二、2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:DescribeSSLStatus。
Version 是 String 公共参数,本接口取值:2017-03-20。
Region 是 String 公共参数,详见产品支持的 地域列表。
InstanceId 否 String 实例 ID。可通过 DescribeDBInstances 接口获取。说明:实例 ID 和只读组 ID 两个参数选其一填写即可。若要查询双节点、三节点实例 SSL 开通情况,请填写实例 ID 参数进行查询。单节点(云盘)、云盘版实例不支持开启 SSL,因此不支持查询。示例值:cdb-test
RoGroupId 否 String 只读组 ID。可通过 DescribeRoGroups 接口获取。说明:实例 ID 和只读组 ID 两个参数选其一填写即可。若要查询只读实例或只读组 SSL 开通情况,请填写 RoGroupId 参数,并注意填写的都是只读组 ID。单节点(云盘)、云盘版实例不支持开启 SSL,因此不支持查询。示例值:cdbrg-test

三、3. 输出参数

参数名称 类型 描述
Status String 是否开通 SSL 。ON 代表开通 ,OFF 代表未开通。示例值:ON
Url String 证书下载链接。示例值:http://testdownload.url
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

四、输入示例

POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSSLStatus
<公共请求参数>
{
"InstanceId": "cdb-je5dfmdl"
}

五、输出示例

{
"Response": {
"Status": "ON",
"Url": "http://***download.url",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}

六、腾讯云 API 平台

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

七、API Inspector

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

八、SDK

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

·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

九、命令行工具

·Tencent Cloud CLI 3.0

十、6. 错误码

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

错误码 描述
InternalError.DBRecordNotExistError 数据库实例不存在。
InternalError.ExecHttpRequestError 执行http请求错误。
InternalError.UnknownError 未知错误。
InvalidParameter.ControllerNotFoundError 未找到该接口。
InvalidParameter.JsonUnmarshalError Json反序列化错误。
MissingParameter.MissingParamError 缺少必要参数。
ResourceNotFound.InstanceNotFoundError 该实例不存在。
赞 (0)
上一篇 4天前
下一篇 4天前