查询防护VPC数
功能介绍
查询防护vpc信息
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/vpcs/protection
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户项目id |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| object_id | 是 | String | 防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id。 |
| enterprise_project_id | 否 | String | 企业项目id，用户支持企业项目后，由企业项目生成的id。 |
| fw_instance_id | 否 | String | 防火墙实例id，创建云防火墙后用于标志防火墙由系统自动生成的标志id，可通过调用查询防火墙实例接口获得，默认情况下，fw_instance_Id为空时，返回账号下第一个墙的信息；fw_instance_Id非空时，返回与fw_instance_Id对应墙的信息。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
响应参数
状态码： 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | VPCProtectsVo object | 防护vpc返回值 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 总VPC数 |
| self_total | Integer | 本项目防护VPC数 |
| other_total | Integer | 其他项目防护VPC数 |
| protect_vpcs | Array of VpcAttachmentDetail objects | 防护VPC |
| self_protect_vpcs | Array of VpcAttachmentDetail objects | 本项目防护VPC |
| other_protect_vpcs | Array of VpcAttachmentDetail objects | 其他项目防护VPC |
| total_assets | Integer | 所有资产数量 |
状态码： 500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| data | data object | 响应体 |
| trace_id | String | trace id |
请求示例
查询项目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 |
错误码
请参见错误码。
