調(diào)用SetCdnDomainSSLCertificate用于設(shè)置某域名下證書功能是否啟用及更新證書信息。
接口說明
- 單用戶調(diào)用頻率：30 次/秒。
- 調(diào)用方式：POST。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| cdn:SetCdnDomainSSLCertificate | update | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 無 |
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 | 否 | 安全證書內(nèi)容，不啟用證書則無需輸入，配置證書請輸入證書內(nèi)容。 | xxx |
| SSLPri | string | 否 | 私鑰內(nèi)容，不啟用證書則無需輸入，配置證書請輸入私鑰內(nèi)容。 | y**** |
| CertRegion | string | 否 | 證書所在地域，只有CertType=cas時生效。支持cn-hangzhou和ap-southeast-1，默認cn-hangzhou。國際站用戶建議使用ap-southeast-1。 | cn-hangzhou |
| Env | string | 否 | 是否灰度下發(fā)證書。 取值：staging：灰度下發(fā)證書。 不傳或者傳任何其他值，都是正式下發(fā)證書。 | staging |
返回參數(shù)
示例
正常返回示例
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參數(shù)缺失。 |
| 400 | SSLPri.MissingParameter | The SSLPri parameter is required. | SSLPri參數(shù)缺失。 |
| 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. | 指定的參數(shù)無效。 |
| 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. | 域名已下線。 |
| 400 | InvalidEnv | The specified Env is invalid. | 指定的是否灰度下發(fā)證書參數(shù)無效。 |
| 403 | DomainInProtectedMode | The domain is in protection mode. To request permission, contact Customer Service. | - |
| 404 | CertName.MissingParameter | You must specify CertName. | - |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-11-28 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-05-07 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-12-06 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2023-09-04 | OpenAPI 錯誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |