调用本接口用于设置某域名下证书功能是否启用及更新证书信息。
接口说明
-
本接口目前仅支持 华东 2（上海） 地域。
-
单用户调用频率：30 次/秒。
-
调用方式：POST。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vod:SetVodDomainSSLCertificate |
update |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DomainName |
string |
是 |
点播加速域名。 |
example.com |
| CertName |
string |
否 |
证书名称。 |
cert_name |
| CertId |
integer |
否 |
证书 id |
12342707 |
| CertType |
string |
否 |
证书类型。
|
cas |
| SSLProtocol |
string |
是 |
HTTPS 证书是否启用。取值：
|
off |
| SSLPub |
string |
否 |
安全证书内容。不启用证书则无需输入，配置证书请输入证书内容。 |
**** |
| SSLPri |
string |
否 |
私钥内容。不启用证书则无需输入，配置证书请输入私钥内容。 |
**** |
| CertRegion |
string |
否 |
证书 Region。取值：
默认值为cn-hangzhou。 |
cn-hangzhou |
| Env |
string |
否 |
是否灰度下发证书。 取值：staging：灰度下发证书。 不传或者传任何其他值，都是正式下发证书。 |
staging |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
F4C6D5BE-BF13-45*****6C-516EA8906DCD |
示例
正常返回示例
JSON格式
{
"RequestId": "F4C6D5BE-BF13-45*****6C-516EA8906DCD"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidSSLProtocol.ValueNotSupported | The specified SSLProtocol is invalid. | |
| 400 | SSLPub.MissingParameter | The SSLPub parameter is required. | |
| 400 | SSLPri.MissingParameter | The SSLPri parameter is required. | |
| 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.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 | InvalidDomain.Offline | The domain provided is offline. | |
| 400 | DomainOwnerVerifyFail | Owner verification of the root domain failed. | 域名验证失败。 |
| 403 | DomainInProtectedMode | The domain is in protection mode. To request permission, contact Customer Service. | |
| 404 | CertName.MissingParameter | You must specify CertName. |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。