調(diào)用SetDcdnDomainSSLCertificate設(shè)置某域名下是否啟用證書功能及更新證書信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 是 | 證書所屬的服務(wù)域名,需屬于 HTTPS 加速類型。 | example.com |
CertName | string | 否 | 證書名稱,目前只支持單個證書名稱,只有 CertType=upload 時生效。 CertType=upload 時選填,給新證書的名稱。 | yourCertName |
CertId | long | 否 | 證書 ID,只有 CertType=cas 時生效。 CertType=cas 時必填,表示選擇已有證書。 | 8089870 |
CertType | string | 否 | 證書類型。
| upload |
SSLProtocol | string | 是 | HTTPS 證書是否啟用。
| off |
SSLPub | string | 否 | 安全證書內(nèi)容,不啟用證書則無需輸入,配置證書請輸入證書內(nèi)容。 | xxx |
SSLPri | string | 否 | 私鑰內(nèi)容,不啟用證書則無需輸入,配置證書請輸入私鑰內(nèi)容。 | y**** |
CertRegion | string | 否 | 證書所在地域,只有 CertType=cas 時生效。支持cn-hangzhou和ap-southeast-1,默認(rèn)cn-hangzhou。國際站用戶建議使用ap-southeast-1。 | cn-hangzhou |
Env | string | 否 | 是否灰度下發(fā)證書。 取值:staging:灰度下發(fā)證書。 不傳或者傳任何其他值,都是正式下發(fā)證書。 | staging |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "A7C69682-7F88-40DD-A198-10D0309E439D"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidSSLProtocol.ValueNotSupported | The specified SSLProtocol is invalid. | 不支持該HTTPS證書開關(guān),請?zhí)顚憃n或off。 |
400 | SSLPub.MissingParameter | The SSLPub parameter is required. | 請?zhí)顚慡SLPub。 |
400 | SSLPri.MissingParameter | The SSLPri parameter is required. | 請?zhí)顚慡SLPri。 |
400 | InvalidSSLPub | The specified SSLPub is invalid. | SSLPub錯誤,請重新填寫。 |
400 | InvalidSSLPri | The specified SSLPri is invalid. | SSLPri錯誤,請?zhí)顚懻_的SSLPri。 |
400 | Certificate.MissMatch | The SSLPri does not match the certificate. | 證書與私鑰不匹配。 |
400 | InvalidCertificate.TooLong | The maximum length of the certificate is exceeded. | Certificate長度超過限制。 |
400 | InvalidCertName.TooLong | The length of the certificate name cannot exceed 128 characters. | 證書名稱不能超過128個字符。 |
400 | AuthenticationFailed | Error performing verification. | 身份驗證失敗。 |
400 | SetDomainCertificate.ParameterError | The specified parameters are invalid. | 參數(shù)錯誤,請?zhí)顚懻_的參數(shù)再重試。 |
400 | Certificate.StatusError | The status of the certificate is invalid. | 證書狀態(tài)錯誤。 |
400 | DeleteFailed | Error deleting the certificate. | 刪除證書失敗。 |
400 | Certificate.NotFind | The certificate does not exist. | 證書不存在。 |
400 | Certificate.Duplicated | The certificate name already exists. | 證書重復(fù)。 |
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. | 證書不存在或證書狀態(tài)錯誤。 |
400 | Certificate.KeyNull | The private key is required. | 私鑰不能為空。 |
400 | Key.Malformed | The specified Key format is invalid. | 參數(shù)Key格式錯誤。 |
400 | CertStorage.failed | Error saving the certificate. | 證書保存失敗。 |
400 | CertificateContent.Duplicated | The certificate has been uploaded; do not upload again. | 證書已經(jīng)上傳,請不要再次上傳。 |
400 | Certificate.Expired | The certificate has expired. | 證書過期了。 |
400 | InvalidDomain.notOnline | The domain is offline. Check the status of the domain and try again later. | 域名未在線,請檢查域名狀態(tài),稍后再試。 |
400 | Decode.Error | Error decoding the SSLPub or SSLPri certificate. | 證書 sslpub 或 sslpri 解碼錯誤。 |
400 | sslPub.Error | Error encoding SSLPub. | sslPub 編碼失敗。 |
400 | sslPri.Error | Error encoding SSLPri. | sslPri 編碼失敗。 |
400 | DomainInSafeMode | The domain is in safe mode. To request permission, contact Customer Service. | 此域名處于安全模式。如果您想做這個操作,請工單聯(lián)系我們。 |
400 | CreateCertificateFailed | Create certificate failed,please try again. | 創(chuàng)建證書失敗,請重新創(chuàng)建證書。 |
400 | Abs.CertRegion.ValueNotSupported | CertRegion is not supported. | 不支持的證書地域。 |
400 | CertNameAlreadyExists | The CertName already exists. | 該證書名稱已存在。 |
400 | Certificate.MissMatch | The certificate does not match the domain. | 證書和域名不匹配。 |
403 | DomainInProtectedMode | The domain is in protection mode. To request permission, contact Customer Service. | 此域名處于被保護(hù)模式。如果您想做這個操作,請聯(lián)系我們。 |
404 | CertName.MissingParameter | You must specify CertName. | 請?zhí)顚懽C書名稱。 |
404 | InvalidDomain.Offline | The domain is offline. | 域名已下線。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-05-11 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-12-06 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-09-04 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |