SetLiveDomainCertificate - 设置域名证书

设置某域名下证书功能是否启用及修改证书信息。

接口说明

先获取直播域名,再调用本接口设置域名下证书是否启用和修改证书信息。

QPS 限制

本接口的单用户 QPS 限制为 30 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

授权信息

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

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

请求参数

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

指定证书所属加速域名。属于https加速类型。

developer.aliyundoc.com
CertNamestring

证书名称。

Cert-****
CertTypestring

证书类型。取值:

  • upload:上传证书。
  • cas:证书中心证书。
  • free:个人测试证书(免费版)。
free
SSLProtocolstring

HTTPS 证书是否启用。取值:

  • on:启用。如果取值为 on,则必须同时设置请求参数 SSLPub 和 SSLPri。
  • off(默认值):不启用。
off
SSLPubstring

公钥内容。

说明 当 SSLProtocol 取值为 on 时,本参数才必填。
****
SSLPristring

私钥内容。

说明 当 SSLProtocol 取值为 on 时,本参数才必填。
****
ForceSetstring

忽略证书名称重复的校验,覆盖原有同名证书信息。固定取值:1

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

示例

正常返回示例

JSON格式

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

错误码

HTTP status code错误码错误信息描述
400InvalidSSLProtocol.ValueNotSupportedThe specified value of parameter SSLProtocol is not supported.-
400SSLPub.MissingParameterAn input parameter "SSLPub" that is mandatory for processing the request is not supplied.-
400SSLPri.MissingParameterAn input parameter "SSLPri" that is mandatory for processing the request is not supplied.-
400InvalidSSLPubThe SSLPub you provided is malformed!-
400InvalidSSLPriThe SSLPri you provided is malformed!-
400Certificate.MissMatchThe SSLPri does not math the specified Certificate!-
400InvalidCertificate.TooLongThe Certificate you provided is over the max length!-
400InvalidCertName.TooLongThe Certificate name you provided is over the max length 128!-
400IllegalOperationDomainYou are not authorized to operate the domain.-
400Certificate.NotPermittedOffTurn off certificate will change domain scheduling, please contact customer service-
400Certificate.SettedNotEffectCertificate was successfully setted but does't take effect for protecting current service, please contact customer service-
400Certificate.NotFindNot find the certificate info.-
400AuthenticationFailedAuthentication failed.-
400SetDomainCertificate.ParameterErrorParameters have error.-
400InvalidSSLPubOrInvalidSSLPriThe SSLPri or SSLPub you provided is malformed!-
400Certificate.MissMatchThe certificate is not match the private key.-
400Certificate.StatusErrorCertificate is not exist or its status is error.-
400DeleteFailedDelete certificate is failed.-
400Certificate.DuplicatedThe certificate name is duplicated.-
400Certificate.FormatErrorThe certificate format is error.-
400Certificate.StatusErrorThe certificate status is error.-
400Certificate.KeyNullThe private key is not null.-
400Key.MalformedThe private key format is error.-
400CertStorage.failedThe certificate storage failed.-
400CertificateContent.DuplicatedThe certificate is already uploaded, please don't upload again.-
400Certificate.ExpiredThe certificate is expired.-
400InvalidDomain.notOnlineThe domain is not online, please check the domain status and try again later.-
400Decode.ErrorThe certificate sslpub or sslpri decode error.-
400sslPub.ErrorThe SSLPub encoded failed.-
400sslPri.ErrorThe SSLPri encoded failed.-
400DomainInSafeModeThis domain is in the safe mode. if you want to do this operation, please contact us!-
400DomainInProtectedModeThis domain is in the protected mode. if you want to do this operation, please contact us!-
400FunctionMutexFunction is mutex with other function.-
403IllegalOperationIllegal domain operate is not permitted.接口权限不足,请您联系管理员,配置访问权限。
404CertName.MissingParameterThe CertName parameter is required.-

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

变更历史

变更时间变更内容概要操作
2024-09-29OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情