Help Center/ Cloud Firewall/ API Reference/ API/ VPC Protection/ Querying the Number of Protected VPCs
Updated on 2023-12-06 GMT+08:00
View PDF

Querying the Number of Protected VPCs

Function

This API is used to query protected VPCs.

Debugging

You can debug this API through automatic authentication in or use the SDK sample code generated by API Explorer.

URI

GET /v1/{project_id}/vpcs/protection

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

object_id

Yes

String

Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.

enterprise_project_id

No

String

Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.

fw_instance_id

No

String

Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

trace_id

String

Call chain ID

data

VPCProtectsVo object

Return value of VPC protection
Table 5 VPCProtectsVo

Parameter

Type

Description

total

Integer

Total number of VPCs

self_total

Integer

Total number of self VPCs

other_total

Integer

Total number of other VPCs

protect_vpcs

Array of VpcAttachmentDetail objects

Protect VPC

self_protect_vpcs

Array of VpcAttachmentDetail objects

Self Protect VPC

other_protect_vpcs

Array of VpcAttachmentDetail objects

Other Protect VPC
Table 6 VpcAttachmentDetail

Parameter

Type

Description

id

String

id

name

String

name

vpc_id

String

vpc id

virsubnet_id

String

subnet id

state

String

state

created_at

String

create time

updated_at

String

update time

tags

Array of Tag objects

tag

description

String

description

project_id

String

project id

vpc_project_id

String

vpc project id

enterprise_project_id

String

enterprise project id
Table 7 Tag

Parameter

Type

Description

key

String

key

value

String

value

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code

Minimum: 8

Maximum: 36

error_msg

String

Description

Minimum: 2

Maximum: 512

Example Requests

Query the east-west firewall protection information about the projected object with the ID 8839526e-b804-4a15-a082-a2c797dce633 in project 0b2179bbe180d3762fb0c01a2d5725c7.

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

Example Responses

Status code: 200

Return value of east-west protection query

{
  "data" : {
    "protect_vpcs" : [ {
      "created_at" : "2022-09-30T02:27:06.33Z",
      "description" : "",
      "id" : "cd7d7f62-0b04-42e8-a859-671dfce75cc1",
      "name" : "er-attach-c4ab",
      "project_id" : "09bb24e6fe80d23d2fa2c010b53b418c",
      "state" : "available",
      "tags" : [ ],
      "updated_at" : "2022-09-30T02:35:35.332Z",
      "virsubnet_id" : "81fda592-b1e9-4437-8078-7fcf786f4e80",
      "vpc_id" : "122c2907-eada-4df4-8ffe-6088cf33d425"
    } ],
    "self_protect_vpcs" : [ ],
    "other_protect_vpcs" : [ ],
    "total" : 1,
    "self_total" : 0,
    "other_total" : 0
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.00109004",
  "error_msg" : "http to external service error"
}

Status Codes

Status Code

Description

200

Return value of east-west protection query

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: VPC Protection