1. 接口描述
接口请求域名: cfw.tencentcloudapi.com 。
获取租户所有VPC防火墙(组)及VPC防火墙实例卡片信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeFwGroupInstanceInfo。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-04。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Limit | 是 | Integer | 每页条数 示例值:20 |
Offset | 是 | Integer | 偏移值 示例值:0 |
Filters.N | 否 | Array of CommonFilter | 过滤条件组合 示例值:[{"Name":"FwGroupName","Values":["andy"],"OperatorType":9}] |
StartTime | 否 | String | 检索的起始时间,可不传 示例值:2022-07-27 16:00:00 |
EndTime | 否 | String | 检索的截止时间,可不传 示例值:2022-07-27 16:00:00 |
Order | 否 | String | desc:降序;asc:升序。根据By字段的值进行排序,这里传参的话则By也必须有值 示例值:desc |
By | 否 | String | 排序所用到的字段 示例值:FwGroupId |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
VpcFwGroupLst | Array of VpcFwGroupInfo | 防火墙(组)详细信息 示例值:[{"FwGroupId":"cfwg-48b0ce59","FwGroupName":"[autotest][勿删]自动化测试","Mode":1,"SwitchMode":1,"FwVpcCidr":"","Status":0,"CdcId":"","CdcName":"","CrossUserMode":"0","FwSwitchNum":1,"RegionLst":["ap-shanghai"],"FwInstanceLst":[{"FwGroupId":"cfwg-48b0ce59","FwInsName":"[autotest]【勿动】自动化测试-上海","FwInsId":"cfwew-091fafd3","FwMode":1,"CcnId":["ccn-2stwf6cr"],"CcnName":["[autotest][勿删]自动化测试"],"PeerConnectionId":null,"PeerConnectionName":null,"FwCvmLst":[{"FwInsId":"cfwew-091fafd3","Region":"ap-shanghai","RegionZh":"上海","RegionDetail":"华东地区","ZoneZh":"上海二区","ZoneZhBack":"上海二区","BandWidth":1024}],"JoinInsLst":[{"JoinType":"VPC","Num":2}],"JoinInsIdLst":["vpc-msa9dvac","vpc-q9h93ip4"],"FwGateway":[{"GatewayId":"havip-0zv7jxun","VpcId":"vpc-eo9n3mq2","IpAddress":"10.183.0.4"}],"JoinInsNum":2,"FwSwitchNum":1,"Status":0,"Time":"2023-09-0712:55:14","Width":1024,"UserVpcWidth":11264,"RuleUsed":56,"RuleMax":20000,"FlowMax":29322,"EngineVersion":"cfw_v4.0.2.1050","UpdateEnable":1,"TrafficMode":"Normal"}]}] |
Total | Integer | 防火墙(组)个数 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取租户所有VPC防火墙(组)及VPC防火墙实例卡片信息
获取租户所有VPC防火墙(组)及VPC防火墙实例卡片信息
输入示例
POST / HTTP/1.1
Host: cfw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFwGroupInstanceInfo
<公共请求参数>
{
"Filters": [
{
"Name": "FwGroupId",
"Values": [
"cfwg-xxxxxxxx"
],
"OperatorType": 9
}
],
"Limit": 10,
"Offset": 0,
"StartTime": "2023-02-08 20:19:13",
"EndTime": "2023-02-08 20:19:13",
"Order": "desc",
"By": "FwGroupId"
}
输出示例
{
"Response": {
"RequestId": "71ed010b-b157-48fb-9439-89aa4549f08b",
"Total": 1,
"VpcFwGroupLst": [
{
"FwGroupId": "cfwg-48b0ce59",
"FwGroupName": "[autotest][勿删]自动化测试",
"Mode": 1,
"SwitchMode": 1,
"FwVpcCidr": "10.0.0.1/24",
"Status": 0,
"CdcId": "cdc-1903e2",
"CdcName": "自动化上海CDC",
"CrossUserMode": "0",
"FwSwitchNum": 1,
"RegionLst": [
"ap-shanghai"
],
"FwInstanceLst": [
{
"FwGroupId": "cfwg-48b0ce59",
"FwInsName": "[autotest]【勿动】自动化测试-上海",
"FwInsId": "cfwew-091fafd3",
"FwMode": 1,
"CcnId": [
"ccn-2stwf6cr"
],
"CcnName": [
"[autotest][勿删]自动化测试"
],
"PeerConnectionId": [],
"PeerConnectionName": [],
"FwCvmLst": [
{
"FwInsId": "cfwew-091fafd3",
"Region": "ap-shanghai",
"RegionZh": "上海",
"RegionDetail": "华东地区",
"ZoneZh": "上海二区",
"ZoneZhBack": "上海二区",
"BandWidth": 1024
}
],
"JoinInsLst": [
{
"JoinType": "VPC",
"Num": 2
}
],
"JoinInsIdLst": [
"vpc-msa9dvac",
"vpc-q9h93ip4"
],
"FwGateway": [
{
"GatewayId": "havip-0zv7jxun",
"VpcId": "vpc-eo9n3mq2",
"IpAddress": "10.183.0.4"
}
],
"JoinInsNum": 2,
"FwSwitchNum": 1,
"Status": 0,
"Time": "2023-09-07 12:55:14",
"Width": 1024,
"UserVpcWidth": 11264,
"RuleUsed": 56,
"RuleMax": 20000,
"FlowMax": 29322,
"EngineVersion": "cfw_v4.0.2.1050",
"UpdateEnable": 1,
"TrafficMode": "Normal"
}
]
}
]
}
}
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 | 操作不支持。 |