目前该API接口已标记为弃用，推荐使用替代API：Cdn(2018-05-10) - SetCdnDomainSSLCertificate。
调用SetDomainServerCertificate设置指定域名下证书信息及证书功能是否启用。
接口说明
说明
单用户调用频率：10 次/秒。
调用方式：POST。
域名业务类型是直播的情况下，设置域名证书可能会引发业务不可用，因此直播域名不允许通过该接口来设置域名证书。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cdn:SetDomainServerCertificate | none |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 是 | 指定证书所属加速域名，需属于 HTTPS 加速类型。 仅支持单个域名查询。 | example.com |
| CertName | string | 否 | 证书名称，仅支持传单个名称。 | myCert1 |
| CertType | string | 否 | 证书类型。取值：
说明
当证书类型为 cas 时，PrivateKey 无需传参。
| cas |
| ServerCertificateStatus | string | 是 | HTTPS 证书是否启用。取值：
| on |
| ServerCertificate | string | 否 | 安全证书内容，不启用证书则无需输入，配置证书请输入证书内容。可通过以下两种方法获取安全证书内容：
| ----BEGIN CERTIFICATE----- MIIFz****-----END CERTIFICATE----- |
| PrivateKey | string | 否 | 私钥内容，不启用证书则无需输入，配置证书请输入私钥内容。 | ----BEGIN RSA PRIVATE KEY-----QswCQ****----END RSA PRIVATE KEY----- |
| ForceSet | string | 否 | 设置为 1 时，忽略证书名称重复的校验，覆盖原有同名证书信息。 | 1 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidServerCertificateStatus.ValueNotSupported | The specified ServerCertificateStatus is invalid. | - |
| 400 | SSLPub.MissingParameter | The SSLPub parameter is required. | SSLPub参数缺失。 |
| 400 | SSLPri.MissingParameter | The SSLPri parameter is required. | SSLPri参数缺失。 |
| 400 | InvalidSSLPub | The specified SSLPub is invalid. | - |
| 400 | InvalidSSLPri | The specified SSLPri is invalid. | - |
| 400 | Certificate.MissMatch | The SSLPri does not match the certificate. | - |
| 400 | InvalidCertificate.TooLong | The Certificate you provided is over the max length | 证书和私钥长度超出限制。 |
| 400 | InvalidCertName.TooLong | The length of the certificate name cannot exceed 128 characters. | - |
| 400 | IllegalOperationDomain | You are not authorized to operate the domain. | 您没有权限操作该域名。 |
| 400 | AuthenticationFailed | Error performing verification. | - |
| 400 | SetDomainCertificate.ParameterError | The specified parameters are invalid. | 指定的参数无效。 |
| 400 | Certificate.StatusError | The status of the certificate is invalid. | - |
| 400 | DeleteFailed | Error deleting the certificate. | - |
| 400 | Certificate.NotFind | The certificate does not exist. | - |
| 400 | Certificate.Duplicated | The certificate name already exists. | - |
| 400 | Certificate.FormatError | The format of the certificate is invalid. | 证书格式错误 |
| 400 | Certificate.StatusError | The certificate does not exist, or the status of the certificate is invalid. | - |
| 400 | Certificate.KeyNull | The private key is required. | - |
| 400 | Key.Malformed | The specified Key format is invalid. | - |
| 400 | CertStorage.failed | Error saving the certificate. | - |
| 400 | CertificateContent.Duplicated | The certificate has been uploaded,do not upload again. | - |
| 400 | Certificate.Expired | The certificate has expired. | - |
| 400 | InvalidDomain.notOnline | The domain is offline. Check the status of the domain and try again later. | - |
| 400 | Decode.Error | Error decoding the SSLPub or SSLPri certificate. | - |
| 400 | sslPub.Error | Error encoding SSLPub. | - |
| 400 | sslPri.Error | Error encoding SSLPri. | - |
| 400 | DomainInSafeMode | The domain is in safe mode. To request permission, contact Customer Service. | - |
| 400 | Certificate.NotPermittedOff | Turn off certificate will change domain scheduling, please contact customer service | - |
| 400 | Certificate.SettedNotEffect | Certificate was successfully setted but does not take effect for protecting current service, please contact customer service | - |
| 400 | Certificate.NotFind | Not find the certificate info. | 证书不存在。 |
| 400 | InvalidSSLPubOrInvalidSSLPri | The SSLPri or SSLPub you provided is malformed. | - |
| 400 | InvalidSSLPub | The SSLPub you provided is malformed. | 证书内容不合法。 |
| 400 | InvalidSSLPri | The SSLPri you provided is malformed. | 证书私钥内容不合法。 |
| 400 | Certificate.MissMatch | The certificate is not match the private key. | 证书与私钥不匹配。 |
| 400 | InvalidDomain.Offline | The domain provided is offline. | 域名已下线。 |
| 403 | DomainInProtectedMode | The domain is in protection mode. To request permission, contact Customer Service. | - |
| 404 | CertName.MissingParameter | The CertName parameter is required. | CertName参数缺失。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-07 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-07-17 | OpenAPI 变更为 deprecated，即将下线、OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-03-22 | OpenAPI 错误码发生变更 | 查看变更详情 |