更新实例证书配置
更新时间 2025-12-03 09:38:38
最近更新时间: 2025-12-03 09:38:38
接口功能介绍
配置实例证书。
接口约束
无
URI
POST /v3/api/ssl/cert/config
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 实例ID | 445d30ce3d5d40a2a79dc444a8c83859 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 实例的资源池ID。 | bb9fdb42056f11eda1610242ac110002 |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| certSrc | 是 | String | 证书来源 | CUSTOMIZE | |
| authType | 是 | String | 证书认证方式 | BI | |
| serverCert | 否 | Object | 服务器证书。仅自定义证书需要 | sslCert | |
| clientCA | 否 | Object | 客户端CA证书。仅自定义证书且双向认证需要 | sslCert | |
| 表 sslCert |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| certId | 是 | String | 证书id | 123 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| message | String | 描述状态 | ||
| statusCode | String | 800-成功 其他失败 | ||
| error | String | 错误码 | ||
| returnObj | Object | 返回对象 |
枚举参数
参数名 certSrc
| 枚举值 | 类型 | 说明 |
|---|---|---|
| CUSTOMIZE | String | 自定义证书 |
| DEFAULT | String | 服务端默认证书 |
| 参数名 authType |
| 枚举值 | 类型 | 说明 |
|---|---|---|
| DI | String | 单向认证 |
| BI | String | 双向认证 |
请求示例
请求url
https://mqtt-global.ctapi.ctyun.cn/v3/api/ssl/cert/config?prodInstId=445d30ce3d5d40a2a79dc444a8c83859
请求头header
{
"regionId":"bb9fdb42056f11eda1610242ac110002"
}
请求体body
{
"certSrc": "CUSTOMIZE",
"authType": "BI",
"serverCert": {
"certId": "xxx"
},
"clientCA": {
"certId": "yyy"
}
}
响应示例
{
"statusCode":800
}
状态码
请参考 状态码
错误码
请参考 错误码
