调用BatchSetCdnDomainServerCertificate批量设置域名下的证书功能是否启用及配置证书信息。
接口说明
说明
单用户调用频率:10 次/秒。
支持批量查询域名,多个域名用半角逗号(,)分隔,一次最多支持配置 10 个域名。
域名业务类型是直播的情况下,设置域名证书可能会引发业务不可用,因此直播域名不允许通过该接口来设置域名证书。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cdn:BatchSetCdnDomainServerCertificate | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 是 | 指定证书所属的加速域名,属于 HTTPS 加速类型,多个域名用英文逗号(,)分隔。 说明
每次最多支持配置 10 个域名。
| example.com |
CertName | string | 否 | 证书名称。 | yourCertName |
CertType | string | 否 | 证书类型。取值:
| cas |
SSLProtocol | string | 是 | HTTPS 证书是否启用。取值:
| on |
SSLPub | string | 否 | 安全证书内容,不启用证书则无需输入,配置证书请输入证书内容。 | yourSSLPub |
SSLPri | string | 否 | 私钥内容,不启用证书则无需输入,配置证书请输入私钥内容。 | yourSSLPri |
Region | string | 否 | 地域。 | your region |
ForceSet | string | 否 | 设置为 1 时,忽略证书名称重复的校验,覆盖原有同名证书信息。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}
错误码
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 Certificate you provided is over the max length | 证书和私钥长度超出限制。 |
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 | 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参数缺失。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-07 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-03-24 | OpenAPI 错误码发生变更 | 查看变更详情 |