1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
创建VPC间防火墙(防火墙组)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateVpcFwGroup。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Name | 是 | String | VPC防火墙(组)名称 示例值:防火墙组 |
Mode | 是 | Integer | 模式 1:CCN云联网模式;0:私有网络模式 2: sase 模式 3:ccn 高级模式 4: 私有网络(跨租户单边模式) 示例值:1 |
VpcFwInstances.N | 是 | Array of VpcFwInstance | 防火墙(组)下的防火墙实例列表 示例值:[{"FwInsId":"cfwew-ace94947","Name":"防火墙(组)第三个实例","VpcIds":["vpc-39sc6ru5"],"FwDeploy":{"DeployRegion":"ap-guangzhou","Width":1024,"CrossAZone":1,"Zone":"ap-guangzhou-1","ZoneBak":"ap-guangzhou-2","CdcId":""}}] |
SwitchMode | 是 | Integer | 防火墙实例的开关模式 1: 单点互通 2: 多点互通 3: 全互通 4: 自定义路由 示例值:1 |
FwVpcCidr | 是 | String | auto 自动选择防火墙网段 10.10.10.0/24 用户输入的防火墙网段 示例值:10.10.10.0/24 |
CcnId | 否 | String | 云联网id ,适用于云联网模式 示例值:ccn-0752de63 |
FwCidrInfo | 否 | FwCidrInfo | 指定防火墙使用网段信息 示例值:{"FwCidrType":"Custom","FwCidrLst":[{"VpcId":"vpc-39sc6ru5","FwCidr":"192.168.1.0/24"}],"ComFwCidr":"cluster-wxecrvtb"} |
CrossUserMode | 否 | String | 跨租户管理员模式 1管理员 2多账号 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FwGroupId | String | 防火墙组ID 示例值:cfwg-0752de63 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建防火墙(组)
创建防火墙(组)
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVpcFwGroup
<公共请求参数>
{
"Name": "新防火墙",
"Mode": 0,
"VpcFwInstances": [
{
"FwInsId": "cfwew-wxecrvrtb",
"Name": "新防火墙实例",
"VpcIds": [
"vpc-0752de63"
],
"FwDeploy": {
"DeployRegion": "ap-guangzhou",
"Width": 1024,
"CrossAZone": 1,
"Zone": "ap-guangzhou-1",
"ZoneBak": "ap-guangzhou-2",
"CdcId": "cluster-0752de63"
}
}
],
"SwitchMode": 1,
"FwVpcCidr": "auto",
"CcnId": "ccn-wxecrevtb",
"FwCidrInfo": {
"FwCidrType": "Custom",
"FwCidrLst": [
{
"VpcId": "vpc-39sc6ru5",
"FwCidr": "192.168.1.0/24"
}
],
"ComFwCidr": "192.168.2.0/24"
}
}
输出示例
{
"Response": {
"FwGroupId": "cfwg-0752de63",
"RequestId": "0752de63-570c-4c2e-bbd2-78574e22a1ae"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |