设置某域名下证书功能是否启用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vs:SetVsDomainCertificate | update | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 是 | 指定证书所属加速域名。 说明
域名需要属于 HTTPS 加速类型。
| example.aliyundoc.com |
SSLProtocol | string | 是 | HTTPS 证书是否启用。取值:
| on |
CertName | string | 否 | 证书名称。 | Cert-77****7 |
CertType | string | 否 | 证书类型。
| free |
SSLPub | string | 否 | 安全证书内容,不启用证书则无需输入,配置证书请输入证书内容。 | 328uiuii28****82dsada81 |
SSLPri | string | 否 | 私钥内容,不启用证书则无需输入,配置证书请输入私钥内容。 | xxxxxxx |
Region | string | 否 | 地域。 | cn-qingdao |
ForceSet | string | 否 | 设置为 1 时,忽略证书名称重复的校验,覆盖原有同名证书信息。 | 1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "119F7639-4646-51A4-B6C1-300D391C0104"
}
错误码
访问错误中心查看更多错误码。
特殊错误码
ErrorCode 错误码 | Message 错误信息 | HTTP 状态 | 语义 |
---|---|---|---|
InvalidDomain.NotFound | The domain provided does not belong to you. | 404 | 域名不存在或不属于当前用户。 |
IllegalOperation | Illegal domain operate is not permitted. | 403 | 没有权限执行当前操作。 |
ServiceBusy | The specified Domain is configuring, please retry later. | 403 | 域名正在配置中,请稍后再试。 |
InvalidDomain.Offline | The domain provided is offline. | 400 | 域名已下线。 |
OperationDenied | Your CDN service is suspended. | 403 | 该账号已经欠费,请充值。 |
InvalidSSLProtocol.ValueNotSupported | The specified value of parameter Enable is not supported. | 400 | SSLProtocol 的值不合法。 |
SSLPub.MissingParameter | An input parameter SSLPub that is mandatory for processing the request is not supplied. | 400 | SSLPub 参数缺失。 |
SSLPri.MissingParameter | An input parameter SSLPri that is mandatory for processing the request is not supplied. | 400 | SSLPri 参数缺失。 |
InvalidCertificate | The Certificate you provided is malformed! | 400 | 证书内容不合法。 |
InvalidSSLPri | The SSLPri you provided is malformed! | 400 | 私钥内容不合法。 |
Certificate.MissMatch | The SSLPri does not math the specified Certificate! | 400 | 证书和私钥不匹配。 |
InvalidCertificate.TooLong | The Certificate you provided is over the max length! | 400 | 证书内容超过长度限制。 |
InvalidCertName.TooLong | The Certificate name you provided is over the max length 128! | 400 | 证书名称不能超过 128 个字符。 |
SetDomainSSLPub.ParameterError | Parameters have error. | 400 | 参数错误。 |
Certificate.StatusError | Certificate is not exist or its status is error. | 400 | 证书不存在或证书状态错误。 |
DeleteFailed | Delete certificate is failed. | 400 | 删除证书失败。 |
Certificate.NotFind | Not find the certificate info. | 400 | 没有查到相应证书。 |
Certificate.Duplicated | The certificate name is duplicated. | 400 | 证书名称重复。 |
Certificate.FormatError | The certificate format is error. | 400 | 证书格式错误。 |
Certificate.StatusError | The certificate status is error. | 400 | 证书状态错误。 |
Certificate.KeyNull | The SSLPri is not null. | 400 | 私钥不能为空。 |
SSLPri.Malformed | The SSLPri format is error. | 400 | 私钥格式错误。 |
Certificate.NotPermittedOff | Turn off certificate will change domain scheduling, please contact customer service. | 400 | 关闭证书会影响该域名调度,请联系客户调整。 |
Certificate.SettedNotEffect | Certificate was successfully setted but does’t take effect for protecting current service, please contact customer service. | 400 | 证书已经设置成功,但为保护当前服务还未生效,请联系客服处理。 |