Help Center/ Cloud Firewall/ API Reference (Ankara Region)/ API/ Address Set Management/ Adding an Address Set
Updated on 2024-12-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Adding an Address Set

Function

This API is used to add an address group.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/address-set

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

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.
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

object_id

Yes

String

Internet border Protected object ID, 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.

name

Yes

String

IP address group name

description

No

String

Address group description

address_type

No

Integer

Address type. The value can be 0 (IPv4) or 1 (IPv6).

Enumeration values:

  • 0

  • 1

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

data

IdObject object

Data returned after an address group is added
Table 6 IdObject

Parameter

Type

Description

id

String

ID

name

String

name

Status code: 400

Table 7 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

Add an IPv4 address group whose project ID is 14181c1245cf4fd786824efe1e2b9388, protected object ID is 1530de8a-522d-4771-9067-9fa4e2f53b48, and name is ceshi.

https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/address-set

{
  "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48",
  "name" : "ceshi",
  "description" : "",
  "address_type" : 0
}

Example Responses

Status code: 200

OK

{
  "data" : {
    "id" : "9dffcd62-23bf-4456-83fa-80fa0fee47db"
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.00900020",
  "error_msg" : "Address groups exceed the maximum limit"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Address Set Management