調(diào)用BatchSetCdnDomainServerCertificate批量設(shè)置域名下的證書(shū)功能是否啟用及配置證書(shū)信息。
接口說(shuō)明
說(shuō)明
單用戶調(diào)用頻率:10 次/秒。
支持批量查詢域名,多個(gè)域名用半角逗號(hào)(,)分隔,一次最多支持配置 10 個(gè)域名。
域名業(yè)務(wù)類型是直播的情況下,設(shè)置域名證書(shū)可能會(huì)引發(fā)業(yè)務(wù)不可用,因此直播域名不允許通過(guò)該接口來(lái)設(shè)置域名證書(shū)。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語(yǔ)句的Action
元素中使用,用來(lái)給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說(shuō)明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問(wèn)級(jí)別:是指每個(gè)操作的訪問(wèn)級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說(shuō)明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問(wèn)級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
cdn:BatchSetCdnDomainServerCertificate | update |
|
| 無(wú) |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 是 | 指定證書(shū)所屬的加速域名,屬于 HTTPS 加速類型,多個(gè)域名用英文逗號(hào)(,)分隔。 說(shuō)明
每次最多支持配置 10 個(gè)域名。
| example.com |
CertName | string | 否 | 證書(shū)名稱。 | yourCertName |
CertType | string | 否 | 證書(shū)類型。取值:
| cas |
SSLProtocol | string | 是 | HTTPS 證書(shū)是否啟用。取值:
| on |
SSLPub | string | 否 | 安全證書(shū)內(nèi)容,不啟用證書(shū)則無(wú)需輸入,配置證書(shū)請(qǐng)輸入證書(shū)內(nèi)容。 | yourSSLPub |
SSLPri | string | 否 | 私鑰內(nèi)容,不啟用證書(shū)則無(wú)需輸入,配置證書(shū)請(qǐng)輸入私鑰內(nèi)容。 | yourSSLPri |
Region | string | 否 | 地域。 | your region |
ForceSet | string | 否 | 設(shè)置為 1 時(shí),忽略證書(shū)名稱重復(fù)的校驗(yàn),覆蓋原有同名證書(shū)信息。 | 1 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
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 Certificate you provided is over the max length | 證書(shū)和私鑰長(zhǎng)度超出限制。 |
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ù)無(wú)效。 |
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. | 證書(shū)格式錯(cuò)誤 |
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 | InvalidDomainNumber.TooLong | The number of the DomainNumber cannot exceed 10. | - |
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參數(shù)缺失。 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-05-07 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2023-03-24 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |