调用SetCdnDomainSSLCertificate用于设置某域名下证书功能是否启用及更新证书信息。
接口说明
- 单用户调用频率：30 次/秒。
- 调用方式：POST。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cdn:SetCdnDomainSSLCertificate | update |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DomainName | string | 是 | 指定证书所属加速域名，需属于 HTTPS 加速类型。仅支持单个域名。 | example.com |
| CertName | string | 否 | 证书名称，目前只支持单个证书名称。 CertType=upload 时选填，给新证书的名称。 | yourCertName |
| CertId | long | 否 | 证书 ID。 CertType=cas 时必填，表示选择已有证书。 | 8089870 |
| CertType | string | 否 | 证书类型。
| upload |
| SSLProtocol | string | 是 | HTTPS 证书是否启用。
| off |
| SSLPub | string | 否 | 安全证书内容，不启用证书则无需输入，配置证书请输入证书内容。 | xxx |
| SSLPri | string | 否 | 私钥内容，不启用证书则无需输入，配置证书请输入私钥内容。 | y**** |
| CertRegion | string | 否 | 证书所在地域，只有CertType=cas时生效。支持cn-hangzhou和ap-southeast-1，默认cn-hangzhou。国际站用户建议使用ap-southeast-1。 | cn-hangzhou |
| Env | string | 否 | 是否灰度下发证书。 取值：staging：灰度下发证书。 不传或者传任何其他值，都是正式下发证书。 | staging |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "A7C69682-7F88-40DD-A198-10D0309E439D\n"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | InvalidSSLProtocol.ValueNotSupported | The specified SSLProtocol 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 maximum length of the certificate is exceeded. | - |
| 400 | InvalidCertName.TooLong | The length of the certificate name cannot exceed 128 characters. | - |
| 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 | CreateCertificateFailed | Create certificate failed,please try again. | - |
| 400 | Abs.CertRegion.ValueNotSupported | CertRegion is not supported. | 不支持的证书地域。 |
| 400 | CertNameAlreadyExists | The CertName already exists. | 该证书名称已存在。 |
| 400 | Certificate.Expired | The certificate is expired. | 证书过期了。 |
| 400 | Certificate.MissMatch | The certificate does not match the domain. | 证书和域名不匹配 |
| 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 | You must specify CertName. | - |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-07 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-12-06 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-09-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |