文档首页/云防火墙 CFW/API参考 (联盟区域) /API/防火墙管理/查询防护VPC数
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询防护VPC数

功能介绍

查询防护vpc信息

URI

GET /v1/{project_id}/vpcs/protection

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID, 可以从调API处获取，也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

object_id

是

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。此处仅取type为1的防护对象id，可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得。

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

fw_instance_id

否

String

防火墙id，可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

Content-Type

是

String

内容类型，只有application/json的值是适用的

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

VPCProtectsVo object

防护vpc返回值

表5 VPCProtectsVo

参数

参数类型

描述

total

Integer

总防护VPC数

self_total

Integer

防火墙东西向防护可进行跨账号防护VPC，self_total表示本项目防护VPC总数。

other_total

Integer

防火墙东西向防护可进行跨账号防护VPC，other_total表示其他项目防护VPC数

protect_vpcs

Array of VpcAttachmentDetail objects

防火墙东西向防护可进行跨账号防护VPC，protect_vpcs指的是总体防护VPC列表

self_protect_vpcs

Array of VpcAttachmentDetail objects

防火墙东西向防护可进行跨账号防护VPC，self_protect_vpcs指的是本项目防护VPC列表

other_protect_vpcs

Array of VpcAttachmentDetail objects

防火墙东西向防护可进行跨账号防护VPC，other_protect_vpcs指的是其他项目防护VPC列表

total_assets

Integer

租户的所有VPC资产数量

表6 VpcAttachmentDetail

参数

参数类型

描述

vpc_id

String

东西向防护添加的防护vpc的id

状态码：500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询项目id为0b2179bbe180d3762fb0c01a2d5725c7，防护对象id为8839526e-b804-4a15-a082-a2c797dce633的东西向墙防护信息

https://{Endpoint}/v1/0b2179bbe180d3762fb0c01a2d5725c7/vpcs/protection?object_id=8839526e-b804-4a15-a082-a2c797dce633

响应示例

状态码：200

查询东西向防护返回值

{
  "data" : {
    "other_protect_vpcs" : [ ],
    "other_total" : 0,
    "protect_vpcs" : [ ],
    "self_protect_vpcs" : [ ],
    "self_total" : 0,
    "total" : 0,
    "total_assets" : 5
  }
}

状态码：400

Bad Request

{
  "error_code" : "CFW.00109004",
  "error_msg" : "HTTP请求错误"
}

状态码

状态码

描述

200

查询东西向防护返回值

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：防火墙管理