用于设置某站点下是否启用证书功能及更新证书信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| esa:SetCertificate | none | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SiteId | long | 是 | 站点 ID。可通过 ListSites 接口获取。 | 1234567890123 |
| Name | string | 否 | 证书名称。 | yourCertName |
| CasId | long | 否 | 云证书 Id。 | 30000478 |
| Type | string | 是 | 证书类型。
| cas |
| Certificate | string | 否 | 证书内容。 | -----BEGIN CERTIFICATE----- |
| PrivateKey | string | 否 | 证书私钥。 | -----BEGIN PRIVATE KEY----- |
| Region | string | 否 | 地域。 | cn-hangzhou |
| Update | boolean | 否 | 是否更新证书。 | true |
| Id | string | 否 | 证书 Id。 | 30001303 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Certificate.StatusError | The status of the certificate is invalid. | 证书状态错误。 |
| 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 | InvalidSSLPub | The specified Certificate is invalid. | Certificate错误，请重新填写。 |
| 400 | InvalidSSLPri | The specified PrivateKey is invalid. | PrivateKey错误，请填写正确的PrivateKey。 |
| 400 | CasId.MissingParameter | The CasId parameter is required. | CasId参数缺失。 |
| 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 | 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. | 指定的证书不存在。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-10-15 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-10-03 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-09-18 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2024-09-06 | OpenAPI 错误码发生变更 | 查看变更详情 |