更新时间:2025-08-28 GMT+08:00
分享

获取私网网段的信息

功能介绍

东西向私网网段查询接口

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/firewall/{fw_instance_id}/east-west/private-network-segments

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以从调API处获取,也可以从控制台获取。项目ID获取方式

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

fw_instance_id

String

参数解释

防火墙ID,用户创建防火墙实例后产生的唯一ID,配置后可区分不同防火墙,可通过防火墙ID获取方式获取

约束限制

不涉及

取值范围

32位UUID

默认取值

不涉及

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

data

ListPrivateNetworkSegmentsVO object

参数解释

私网网段信息列表

取值范围

不涉及

表3 ListPrivateNetworkSegmentsVO

参数

参数类型

描述

private_network_list

Array of PrivateNetworkSegmentVO objects

参数解释

私网网段列表

取值范围

不涉及

total

Integer

参数解释

总条数

取值范围

不涉及

quota

Integer

参数解释

私网网段配额

取值范围

不涉及

support_az_list

Array of strings

参数解释

支持的可用区列表

取值范围

不涉及

表4 PrivateNetworkSegmentVO

参数

参数类型

描述

conf_id

String

参数解释

私网网段ID,更新私网网段时需要

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

protect_network

String

参数解释

私网网段,格式为:IP/Mask

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

az_info

String

参数解释

私网网段的可用区信息,如AZ1

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

subnet_name

String

参数解释

子网名称

约束限制

不涉及

取值范围

不涉及

默认取值

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码

取值范围

不涉及

error_msg

String

参数解释

错误描述

取值范围

不涉及

请求示例

查询东西向私网网段列表,项目ID为176d761dc156471c9c9b227376594160,防火墙ID为48e074e4-3b1a-448b-a17f-2fd2a12df1d2f

https://{Endpoint}v2/176d761dc156471c9c9b227376594160/firewall/48e074e4-3b1a-448b-a17f-2fd2a12df1d2/east-west/private-network-segments

响应示例

状态码:200

私网网段信息列表

{
  "data" : {
    "private_network_list" : [ {
      "conf_id" : "4",
      "protect_network" : "100.64.0.0/10"
    }, {
      "conf_id" : "1",
      "protect_network" : "10.0.0.0/8",
      "az_info" : "AZ1",
      "subnet_name" : "test"
    }, {
      "conf_id" : "2",
      "protect_network" : "172.16.0.0/12"
    }, {
      "conf_id" : "3",
      "protect_network" : "192.168.0.0/16"
    } ],
    "total" : 4,
    "quota" : 32,
    "support_az_list" : [ "AZ1", "AZ3" ]
  }
}

状态码:400

Bad Request

{
  "error_code" : "CFW.00000008",
  "error_msg" : "系统内部错误"
}

状态码

状态码

描述

200

私网网段信息列表

400

Bad Request

错误码

请参见错误码

相关文档