创建VPC边界防火墙(防护云企业网内的网络实例和指定VPC之间的互访流量)。
接口说明
本接口一般用于为云企业网内的 VPC 实例创建 VPC 边界防火墙。该 VPC 边界防火墙可以防护云企业网内的网络实例(网络实例包含 VPC、VBR 和 CCN)和指定 VPC 之间的互访流量,不支持防护 VBR 与 VBR、CCN 与 CCN、VBR 与 CCN 之间的互访流量。更多信息,请参见 VPC 边界防火墙限制说明。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-cloudfirewall:CreateVpcFirewallCenConfigure | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Lang | string | 否 | 请求和接收消息的语言类型。取值:
| zh |
VpcFirewallName | string | 是 | VPC 边界防火墙的实例名称。 | 测试用实例 |
NetworkInstanceId | string | 是 | 创建 VPC 边界防火墙的 VPC 实例 ID。 | vpc-bp10zlifxh6j0232w**** |
VpcRegion | string | 是 | 创建 VPC 边界防火墙的 VPC 所属地域 ID。 说明
关于云防火墙支持地域的详细信息,请参见支持的地域。
| cn-hangzhou |
FirewallSwitch | string | 是 | 设置 VPC 边界防火墙的开关状态。取值:
| open |
CenId | string | 是 | 云企业网实例 ID。 | cen-x5jayxou71ad73**** |
MemberUid | string | 否 | 当前阿里云账号的成员账号 UID。 | 258039427902**** |
VSwitchId | string | 否 | 指定云防火墙接口所属的 vSwitch ID。 | vsw-qzeaol304m*** |
FirewallVpcCidrBlock | string | 否 | 防火墙所使用 VPC 网段, 需配置子网掩码不大于 28 位网段来分配给创建防火墙过程所需 VPC 网段,用以自动创建防火墙安全 VPC(Cloud_Firewall_VPC)进行流量引流处理。 如果不填此参数,则默认自动分配网段 10.0.0.0/8。 说明
参数仅本 CEN 本地域首次创建 VPC 防火墙时有效。
| 10.0.0.0/8 |
FirewallVpcZoneId | string | 否 | 防火墙交换机所属的可用区 ID。 如果您的业务延时敏感,您可以自定义防火墙交换机可用区和业务 VPC 交换机可用区相同,以便降低延时。 如果不填此参数,则默认自动分配交换机可用区。 说明
参数仅本 CEN 本地域首次创建 VPC 防火墙时有效。关于各地域可用区的详细信息,请参见查询可用区列表 API。
| cn-hangzhou-a |
FirewallVSwitchCidrBlock | string | 否 | 防火墙所使用 vSwitch 网段, 需配置子网掩码不大于 29 位且不与网络规划冲突的网段来分配给创建防火墙过程所需 vSwitch 网段,用以自动创建防火墙安全 VPC 内的交换机(Cloud_Firewall_VSWITCH)进行流量引流处理。交换机网段必须是防火墙 VPC 网段的子网。 如果不填此参数, 则默认自动分配网段 10.219.219.216/29。 说明
参数仅本 CEN 本地域首次创建 VPC 防火墙时有效。
| 10.0.*.*/28 |
返回参数
示例
正常返回示例
JSON
格式
{
"VpcFirewallId": "vfw-m5e7dbc4y****",
"RequestId": "850A84D6-0DE4-4797-A1E8-00090125h4j6"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ErrorAliUid | The aliuid is invalid. | 无效的用户id |
400 | ErrorVpcFirewallExist | The firewall has been configured and cannot be created repeatedly. | 防火墙已配置,不能重复新建 |
400 | ErrorVpcId | The VPC ID is invalid. | 无效的VPCID |
400 | ErrorRegionNoError | The region is invalid. | 无效的区域 |
400 | ErrorVpcFirewallNotFound | The specified VPC firewall does not exist. Please select again. | 指定的VPC防火墙不存在,请重新选择 |
400 | ErrorDBSelectError | A database select error occurred. | 内部错误:数据库查询错误 |
400 | ErrorDBTxError | A database transaction error occurred. | 内部错误:数据库事务错误 |
400 | ErrorDBUpdateError | A database update error occurred. | 内部错误:数据库更新错误 |
400 | ErrorRecordLog | An error occurred while updating the operation log. | 写日志失败 |
400 | ErrorCenVbrNotSupport | 云企业网vbr不支持开防火墙 | - |
400 | ErrorCenNotSupportCCN | VPC防火墙云企业网CCN实例, 不支持开启VPC防火墙 | - |
400 | ErrorCenNotSupportMultipleAccounts | The current version of Cloud Firewall does not support multiple accounts when it uses VPC Firewall to protect Cloud Enterprise Network. Upgrade the specifications and try again. | 云防火墙当前版本VPC防火墙云企业网不支持多账号,请升级规格后重试 |
400 | ErrorFirewallStatus | Firewall status error, please try again later. | 防火墙状态错误,请稍后再试 |
400 | ErrorFirewallQuotaNotEmpty | quota is not enough, unable to configure VPC firewall, please increase quota first. | - |
400 | ErrorHubvpcCannotCreate | HUB VPC不允许创建防火墙 | - |
400 | ErrorCenVpcEcConflict | The VPC of the cloud enterprise network conflicts with the VPC of the high-speed channel, and the firewall cannot be opened. Please select again | 云企业网VPC和高速通道VPC冲突,无法开启防火墙,请重新选择 |
400 | ErrorRegionNoDisable | There are unsupported regions, please reselect | 存在不支持的地域,请重新选择 |
400 | ErrorCenFirewallVpcNumInvalid | 云企业网vpc数量不足, 无法开启VPC边界防火墙 | - |
400 | ErrorDestCidrError | The target network segment is wrong. Please configure the target network segment correctly. | 目标网段错误,请正确配置目标网段 |
400 | ErrorVpcCustomRouteTableWithVswitch | VPC存在自定义路由表且关联了vswitch, 不允许创建VPC防火墙 | - |
400 | ErrorCenNotSupportTREnterpriseAutoMode | VPC firewall does not support TR Enterprise Edition auto mode protection, please use manual mode protection | VPC 防火墙不支持 CEN-TR自动模式 |
400 | ErrorInvalidMemberUid | Member uid is invalid | 成员账号错误. |
400 | ErrorFirewallName | Firewall name invalid. | 防火墙名错误,请重新输入。 |
400 | ErrorFirewallSwitch | The firewall enabling parameter is incorrect. Please select again. | 防火墙开关参数错误,请重新选择 |
400 | ErrorNetworkInstanceIdError | Network InstanceId ID is invalid | 网络实例id非法 |
400 | ErrorCenId | CEN ID is error | cen id 错误 |
400 | ErrorRegionNoError | Region is error, please reselect | 地域选择错误, 请重新输入 |
400 | ErrorCidrFormat | Cidr ip format error. | 网段CIDR格式错误,请重新选择 |
400 | ErrorDestCidrError | The destination CIDR block is invalid. | 目标网段错误,请正确配置目标网段 |
400 | ErrorDestCidrEmpty | The target network segment is empty and cannot be created | 目标网段为空, 不允许创建. |
400 | ErrorOwnerId | owner id invalid. | 所属账号错误,请重新输入。 |
400 | ErrorHubvpcCannotCreate | HUB VPC could not create vpc firewall | HUB VPC不允许创建防火墙 |
400 | ErrorFirewallQuotaNotEmpty | The quota for VPC firewalls is exceeded. | 配额不足,无法配置VPC防火墙,请先增加配额 |
400 | ErrorVpcFirewallExist | Vpc firewall already exist. | 防火墙已配置,不能重复配置。 |
400 | ErrorCenVbrNotSupport | CEN vbr not support firewall. | 云企业网vbr不支持开防火墙 |
400 | ErrorCenNotSupportCCN | Cloud enterprise network CCN instance does not support opening VPC firewall | VPC防火墙云企业网CCN实例, 不支持开启VPC防火墙 |
400 | ErrorCenManualFirewallExist | VPC firewall in manual mode already exists in this CEN network. You are not allowed to create a VPC firewall in automatic mode. | 此云企业网已存在手动模式的VPC边界防火墙, 不允许创建自动模式的VPC防火墙。 |
400 | ErrorFirewallExistDeleting | There is a VPC firewall that is being deleted, and it is not allowed to create. | 存在删除中的VPC防火墙, 不允许创建。 |
400 | ErrorCenFirewallVpcNumInvalid | The number of VPCs in the cloud enterprise network is insufficient, and the VPC firewall cannot be opened | 云企业网vpc数量不足, 无法开启VPC边界防火墙 |
400 | ErrorSameCidrIp | The same network segment cannot be configured repeatedly. Please reselect the network segment. | 相同网段不能重复配置, 请重新选择网段 |
400 | ErrorCenRouteMapExist | cen route map is exist. | RouteMap已存在, 不允许创建VPC边界防火墙。请联系云防火墙售后技术支持处理。 |
400 | ErrorUserCredentials | User credentials failed. | 未授权,不可访问,请先授权防火墙权限。 |
400 | ErrorDBNoRow | No rows in database. | 没有数据 |
400 | ErrorVpcFirewallVpcNumLimit | The number of vpcs in this region is limited to open the vpc firewall. | 此地域内vpc数量限制, 无法开启VPC边界防火墙。 |
400 | ErrorCenExistPublicCidr | cen domain route exist public route. | 云企业网内存在公网网段, 不支持开启VPC边界防火墙。 |
400 | ErrorCenExistTrRoute | Cen VPC route exist tr route. | 云企业网内的VPC存在下一跳是TR的路由, 不支持开启VPC边界防火墙。 |
400 | ErrorCenTRAssociationCustomRouteTable | CEN-TR association custom route table. | VPC边界防火墙不支持CEN-TR网络实例连接关联自定义路由表, 无法开启VPC边界防火墙。 |
400 | ErrorVpcCustomRouteTableWithVswitch | VPC has a custom routing table and is associated with vswitch. It is not allowed to create VPC firewall | VPC存在自定义路由表且关联了vswitch, 不允许创建VPC防火墙 |
400 | ErrorDBInsertError | A database insert error occurred. | 内部错误:数据库插入错误 |
400 | ErrorCenFirewallVpcNumInvalid | The number of VPCs in the cloud enterprise network is insufficient, and the VPC firewall cannot be opened. | 云企业网VPC数量不足, 无法开启VPC边界防火墙。 |
400 | ErrorNetworkInstanceIdError | Network InstanceId ID is invalid. | 网络实例ID非法。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-09-06 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更 | 查看变更详情 |
2023-06-13 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |