Help Center/ Cloud Firewall/ API Reference/ API/ Inter-VPC Firewall Management/ Querying the Inspection VPC Used by a VPC Border Firewall
Updated on 2025-08-12 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Inspection VPC Used by a VPC Border Firewall

Function

This API is used to query the inspection VPC used by a VPC border firewall.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/firewall/east-west/inspection-vpc

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

32-bit UUID.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

fw_instance_id

Yes

String

Definition

Firewall ID. It is a unique ID generated after a firewall instance is created. You can obtain the firewall ID by referring to Obtaining a Firewall ID.

Constraints

N/A

Range

32-bit UUID.

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

data

data object

Definition

Response body for querying the inspection VPC used by the VPC border firewall.

Range

N/A
Table 4 data

Parameter

Type

Description

inspection_vpc_list

Array of InspectionVpcInfo objects

Definition

Inspection VPC list.

Range

N/A
Table 5 InspectionVpcInfo

Parameter

Type

Description

inspection_vpc_id

String

Definition

Inspection VPC.

Range

N/A

name

String

Definition

Inspection VPC.

Range

N/A

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

Range

N/A

error_msg

String

Definition

Error message.

Range

N/A

Example Requests

The project ID is a16df7cf1d094befa6bbc72cbf51e93a, and firewall ID is af050cf8-8ad8-4c12-a027-d7a5784e0f64. Query the information about the inspection VPC used by a VPC border firewall.

https://{Endpoint}/v1/a16df7cf1d094befa6bbc72cbf51e93a/firewall/east-west/inspection-vpc?fw_instance_id=af050cf8-8ad8-4c12-a027-d7a5784e0f64

Example Responses

Status code: 400

Bad Request

{
  "error_code" : "CFW.00200003",
  "error_msg" : "Parameter error."
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.

Parent Topic: Inter-VPC Firewall Management