当原证书过期需替换为新的证书且关联域名不变时,您可以调用UpdateAdditionalCertificateWithListener接口为HTTPS监听替换扩展证书。
接口说明
本接口用于替换扩展证书。仅适用于原证书过期,需替换为新的证书且关联域名不变的场景。
-
UpdateAdditionalCertificateWithListener 接口属于异步接口,即系统会先返回一个请求 ID,但 HTTPS 监听的扩展证书并未替换完成,系统后台的替换任务仍在进行。您可以调用 ListListenerCertificates 查询监听绑定的证书状态:
-
当待替换证书处于 updating 状态时,表示 HTTPS 监听的扩展证书正在替换中,在该状态下,您只能执行查询操作,不能执行其他操作。
-
当新证书处于 active 状态时,表示 HTTPS 监听的扩展证书替换完成并已生效。
-
-
UpdateAdditionalCertificateWithListener 接口不支持在同一个全球加速实例内并发为 HTTPS 监听替换扩展证书。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ga:UpdateAdditionalCertificateWithListener | update |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 全球加速实例所在的地域 ID,仅取值cn-hangzhou。 | cn-hangzhou |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-426655440000 |
AcceleratorId | string | 是 | 全球加速实例 ID。 | ga-bp1odcab8tmno0hdq**** |
ListenerId | string | 是 | 监听 ID。仅支持 HTTPS 协议类型的监听。 | lsr-bp1bpn0kn908w4nbw**** |
Domain | string | 是 | 原扩展证书绑定的域名。 | example.com |
CertificateId | string | 是 | 新的证书 ID。 | 6092**-cn-hangzhou |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
"ListenerId": "lsr-bp1bpn0kn908w4nbw****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NotExist.Accelerator | The accelerated instance does not exist. | 加速实例不存在。 |
400 | StateError.Accelerator | The state of the accelerated instance is invalid. | 加速实例状态非法。 |
400 | NotExist.Listener | The listener does not exist. | 监听器不存在 |
400 | NotActive.Listener | The state of the listener is not active. | 监听器状态非稳态 |
400 | ResourceNotFound.CertificateDomain | The specified domain is not found. | - |
400 | CertificateNotSupportDomain | The certificate does not support the current domain, please check. | 证书与当前域名不匹配,请检查。 |
500 | UnknownError | An error occurred while processing your request. Please try again. If the error persists, please submit a ticket. | 处理请求时出现错误,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-10-09 | OpenAPI 错误码发生变更 | 查看变更详情 |