文档

BatchSetCdnDomainServerCertificate - 批量设置域名证书

更新时间:

调用BatchSetCdnDomainServerCertificate批量设置域名下的证书功能是否启用及配置证书信息。

接口说明

说明
  • 单用户调用频率:10 次/秒。
  • 支持批量查询域名,多个域名用半角逗号(,)分隔,一次最多支持配置 10 个域名。
  • 域名业务类型是直播的情况下,设置域名证书可能会引发业务不可用,因此直播域名不允许通过该接口来设置域名证书。
  • 调试

    您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

    • 操作:是指具体的权限点。
    • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
    • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
      • 对于必选的资源类型,用背景高亮的方式表示。
      • 对于不支持资源级授权的操作,用全部资源表示。
    • 条件关键字:是指云产品自身定义的条件关键字。
    • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    cdn:BatchSetCdnDomainServerCertificateWrite
    • Domain
      acs:cdn:*:{#accountId}:domain/{#DomainName}

    请求参数

    名称类型必填描述示例值
    DomainNamestring

    指定证书所属的加速域名,属于 HTTPS 加速类型,多个域名用英文逗号(,)分隔。

    说明 每次最多支持配置 10 个域名。
    example.com
    CertNamestring

    证书名称。

    yourCertName
    CertTypestring

    证书类型。取值:

    • upload:上传证书。

    • cas:证书中心证书。

    cas
    SSLProtocolstring

    HTTPS 证书是否启用。取值:

    • on:启用。

    • off(默认值):不启用。

    on
    SSLPubstring

    安全证书内容,不启用证书则无需输入,配置证书请输入证书内容。

    yourSSLPub
    SSLPristring

    私钥内容,不启用证书则无需输入,配置证书请输入私钥内容。

    yourSSLPri
    Regionstring

    地域。

    your region
    ForceSetstring

    设置为 1 时,忽略证书名称重复的校验,覆盖原有同名证书信息。

    1

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    0AEDAF20-4DDF-4165-8750-47FF9C1929C9

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
    }

    错误码

    HTTP status code错误码错误信息描述
    400InvalidSSLProtocol.ValueNotSupportedThe specified SSLProtocol is invalid.-
    400SSLPub.MissingParameterThe SSLPub parameter is required.SSLPub参数缺失。
    400SSLPri.MissingParameterThe SSLPri parameter is required.SSLPri参数缺失。
    400InvalidSSLPubThe specified SSLPub is invalid.-
    400InvalidSSLPriThe specified SSLPri is invalid.-
    400Certificate.MissMatchThe SSLPri does not match the certificate.-
    400InvalidCertificate.TooLongThe Certificate you provided is over the max length证书和私钥长度超出限制。
    400InvalidCertName.TooLongThe length of the certificate name cannot exceed 128 characters.-
    400AuthenticationFailedError performing verification.-
    400SetDomainCertificate.ParameterErrorThe specified parameters are invalid.指定的参数无效。
    400Certificate.StatusErrorThe status of the certificate is invalid.-
    400DeleteFailedError deleting the certificate.-
    400Certificate.NotFindThe certificate does not exist.-
    400Certificate.DuplicatedThe certificate name already exists.-
    400Certificate.FormatErrorThe format of the certificate is invalid.证书格式错误
    400Certificate.StatusErrorThe certificate does not exist, or the status of the certificate is invalid.-
    400Certificate.KeyNullThe private key is required.-
    400Key.MalformedThe specified Key format is invalid.-
    400CertStorage.failedError saving the certificate.-
    400CertificateContent.DuplicatedThe certificate has been uploaded; do not upload again.-
    400Certificate.ExpiredThe certificate has expired.-
    400InvalidDomain.notOnlineThe domain is offline. Check the status of the domain and try again later.-
    400Decode.ErrorError decoding the SSLPub or SSLPri certificate.-
    400sslPub.ErrorError encoding SSLPub.-
    400sslPri.ErrorError encoding SSLPri.-
    400DomainInSafeModeThe domain is in safe mode. To request permission, contact Customer Service.-
    400InvalidDomainNumber.TooLongThe number of the DomainNumber cannot exceed 10.-
    400InvalidDomain.OfflineThe domain provided is offline.域名已下线。
    403DomainInProtectedModeThe domain is in protection mode. To request permission, contact Customer Service.-
    404CertName.MissingParameterThe CertName parameter is required.CertName参数缺失。

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-03-24OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
      删除错误码:403
      删除错误码:404
    • 本页导读 (1)