# 获取私网网段的信息 - ListPrivateNetworkSegments #### 功能介绍 东西向私网网段查询接口 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-cfw/cfw_02_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-cfw/cfw_02_0018.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v2/{project_id}/firewall/{fw_instance_id}/east-west/private-network-segments 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**： 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。[项目ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0015.html) **约束限制**： 不涉及 **取值范围**： 32位UUID **默认取值**： 不涉及 | | fw_instance_id | 是 | String | **参数解释**： 防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过[防火墙ID获取方式](https://support.huaweicloud.com/api-cfw/cfw_02_0028.html)获取 **约束限制**： 不涉及 **取值范围**： 36位UUID **默认取值**： 不涉及 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | data | [ListPrivateNetworkSegmentsVO] object | **参数解释**： 私网网段信息列表 **取值范围**： 不涉及 | 表3ListPrivateNetworkSegmentsVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | private_network_list | Array of [PrivateNetworkSegmentVO] objects | **参数解释**： 私网网段列表 **取值范围**： 不涉及 | | total | Integer | **参数解释**： 总条数 **取值范围**： 不涉及 | | quota | Integer | **参数解释**： 私网网段配额 **取值范围**： 不涉及 | | support_az_list | Array of strings | **参数解释**： 支持的可用区列表 **取值范围**： 不涉及 | 表4PrivateNetworkSegmentVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | conf_id | String | **参数解释**： 私网网段ID，可以通过调用\[获取私网网段的信息\]获得，通过返回值中的data.private_network_list.conf_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-2fd2a12df1d2 ``` 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" : "系统内部错误" } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.cfw.v1.region.CfwRegion; import com.huaweicloud.sdk.cfw.v1.*; import com.huaweicloud.sdk.cfw.v1.model.*; public class ListPrivateNetworkSegmentsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); CfwClient client = CfwClient.newBuilder() .withCredential(auth) .withRegion(CfwRegion.valueOf("")) .build(); ListPrivateNetworkSegmentsRequest request = new ListPrivateNetworkSegmentsRequest(); request.withFwInstanceId("{fw_instance_id}"); try { ListPrivateNetworkSegmentsResponse response = client.listPrivateNetworkSegments(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcfw.v1.region.cfw_region import CfwRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcfw.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = CfwClient.new_builder() \ .with_credentials(credentials) \ .with_region(CfwRegion.value_of("")) \ .build() try: request = ListPrivateNetworkSegmentsRequest() request.fw_instance_id = "{fw_instance_id}" response = client.list_private_network_segments(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cfw "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cfw/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cfw.CfwClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cfw.NewCfwClient(hcClient) request := &model.ListPrivateNetworkSegmentsRequest{} request.FwInstanceId = "{fw_instance_id}" response, err := client.ListPrivateNetworkSegments(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CFW/sdk?api=ListPrivateNetworkSegments)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 私网网段信息列表 | | 400 | Bad Request | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-cfw/ErrorCode.html)。