调用AssociateVpnGatewayWithCertificate接口为VPN网关绑定证书。
接口说明
在将 VPN 网关和 SSL 证书进行绑定前,请先了解以下信息:
-
仅国密型 VPN 网关支持绑定 SSL 证书,您需要为国密型 VPN 网关绑定 2 个 SSL 证书,一个作为加密证书,一个作为签名证书。
-
SSL 证书需使用国密算法。
-
在同一个 VPN 网关实例下,不支持将同一个 SSL 证书同时指定为加密证书和签名证书。
-
首次绑定 VPN 网关和 SSL 证书时,系统会自动创建一个名称为 AliyunServiceRoleForVPNCertificate 的服务关联角色,并且为该角色添加名称 AliyunServiceRolePolicyForVPNCertificate 的权限策略,授予 VPN 网关拥有访问其他云资源的权限。更多信息,请参见 AliyunServiceRoleForVPNCertificate 。
-
AssociateVpnGatewayWithCertificate 接口属于异步接口,即系统先返回一个请求 ID,但该 VPN 网关尚未成功绑定 SSL 证书,系统后台的绑定任务仍在进行。您可以调用 DescribeVpnGateway 接口查询 SSL 证书的绑定状态:
- 当 VPN 网关处于 updating 状态时,表示 SSL 证书正在绑定中。
- 当 VPN 网关处于 active 状态时,表示 SSL 证书绑定成功。
-
AssociateVpnGatewayWithCertificate 接口不支持为同一个 VPN 网关并发绑定 SSL 证书。
前提条件
请确保您已经在阿里云数字证书管理服务控制台拥有 2 个使用国密算法的 SSL 证书。关于 SSL 证书的更多信息,请参见什么是数字证书管理服务。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | VPN 网关所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
VpnGatewayId | string | 是 | VPN 网关实例 ID。 说明
仅国密型 VPN 网关支持绑定证书。
| vpn-bp1q8bgx4xnkm2ogj**** |
CertificateType | string | 是 | 证书类型。取值:
| Signature |
CertificateId | string | 是 | 证书 ID。 | 6bfe4218-ea1d**** |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 0c593ea1-3bea**** |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "4EC47282-1B74-4534-BD0E-403F3EE64CAF"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalParam.CertificateType | The specified certificate type (%s) is invalid. | - |
400 | OperationFailed.NotNationalStandard | The VPN gateway is not national standard. | - |
400 | VpnGateway.Configuring | The specified service is configuring. | 服务正在配置中,请您稍后再试。 |
400 | OperationFailed.NoRamPermission | VPN service has no permission to operate your KMS instances. | - |
400 | OperationFailed.AssociationExist | The association already exists. | 由于当前资源处于绑定中操作失败 |
400 | OperationFailed.AnotherAssociationExist | The VPN gateway has associated with %s. | 当前vpn实例已与同类证书绑定。 |
400 | SystemBusy | The system is busy. Please try again later. | 当前系统繁忙,请稍后重试。 |
400 | OperationFailed.InvalidCertificate | The specified certificate is invalid. | - |
403 | Forbidden | User not authorized to operate on the specified resource. | 您没有权限操作指定资源,请申请权限后再操作。 |
403 | Forbidden.NoSlrPermission | User not authorized to create service linked role. | - |
404 | InvalidVpnGatewayInstanceId.NotFound | The specified vpn gateway instance id does not exist. | 指定的 VPN 网关不存在,请您检查 VPN 网关是否正确。 |
404 | InvalidCertificateId.NotFound | The specified certificate ID (%s) does not exist. | - |
409 | OperationConflict | The operation against this instance is too frequent, please try again later. | 对该实例的操作过于频繁,请稍后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-02-22 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |