创建/更新一个Keyless server配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SiteId |
integer |
是 |
站点 ID,可通过调用 ListSites 接口获取。 |
123456**** |
| Host |
string |
是 |
Keyless server 主机名,取值域名或 IP 地址。 |
keyless.example.com |
| Port |
integer |
是 |
Keyless server 端口。 |
443 |
| Verify |
boolean |
否 |
是否校验 Keyless server 服务端证书,默认 false。 |
true |
| CaCertificate |
string |
否 |
用于校验 Keyless server 服务端证书的 CA 证书,当 Verify 为 true 时有效。 |
-----BEGIN CERTIFICATE-----**** |
| ClientCertificate |
string |
否 |
客户端证书,需要和客户端私钥成对出现。 |
-----BEGIN CERTIFICATE-----**** |
| ClientPrivateKey |
string |
否 |
客户端私钥,需要和客户端证书成对出现。 |
-----BEGIN RSA PRIVATE KEY-----**** |
| Id |
string |
否 |
Keyless server ID。 |
baba39055622c008b90285a8838e**** |
| Name |
string |
是 |
Keyless server 名称。 |
example |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
34DCBC8A-****-****-****-6DAA11D7DDBD |
| Id |
string |
Keyless server ID。 |
babaabcd**** |
| SiteId |
integer |
站点 ID。 |
123456**** |
| SiteName |
string |
站点名称。 |
example.com |
示例
正常返回示例
JSON格式
{
"RequestId": "34DCBC8A-****-****-****-6DAA11D7DDBD",
"Id": "babaabcd****",
"SiteId": 0,
"SiteName": "example.com"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Certificate.Duplicated | The certificate name already exists. | 证书重复。 |
| 400 | InvalidParameter | The specified parameter is invalid. | 输入参数规范校验失败。 |
| 400 | InvalidCertificate.NotFound | The specified certificate does not match the website. Check the validity of the certificate and try again. | 您提供的证书与该站点不匹配,请确认证书的有效性并重新发起请求。 |
| 400 | PrivateKey.MissingParameter | The PrivateKey parameter is required. | PrivateKey参数缺失。 |
| 400 | Certificate.MissingParameter | The Certificate parameter is required. | Certificate参数缺失。 |
| 400 | InvalidParameter.SiteId | Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again. | SiteId参数无效,无法通过指定的SiteId获取对应的站点名称,请确认SiteId后重试。 |
| 400 | InvalidSSLPub | The specified Certificate is invalid. | Certificate错误,请重新填写。 |
| 400 | InvalidSSLPri | The specified PrivateKey is invalid. | PrivateKey错误,请填写正确的PrivateKey。 |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | 调用服务失败,请稍后重试或联系客服咨询详情。 |
| 400 | UpdateFreeCertificate.NotSupport | The free certificate does not support the update operation. | 免费证书不支持更新操作。 |
| 400 | CertificateDomainNotMatchSite | The domain name in the specified certificate does not match the site. | 证书中的域名和当前站点不匹配。 |
| 400 | CertificateNotMatchPrivateKey | The specified certificate does not match the private key. | 指定的证书和私钥不匹配。 |
| 400 | CertQuotaCheckFailed | The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan. | 自定义证书配额校验失败,上传证书数量超过套餐允许上限。 |
| 404 | Certificate.NotFound | The specified certificate does not exist. | 指定的证书不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。