doc-exports/docs/cfw/api-ref/AddAddressItem.html

Adding an Address Set Member

Function

This API is used to add an address group member.

URI

POST /v1/{project_id}/address-items

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
set_id	No	String	ID of the IP address group
address_items	No	Array of address_items objects	Address group member information

Table 5 address_items

Parameter	Mandatory	Type	Description
name	Yes	String	Address name
address_type	No	Integer	Address type. The value can be 0 (IPv4) or 1 (IPv6).
address	No	String	IP address information of the address group
description	No	String	Address group member description

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter	Type	Description
data	AddressItems object	Data returned after an address group member is added

Table 7 AddressItems

Parameter	Type	Description
items	Array of IdObject objects	List of address group member IDs
covered_ip	Array of CoveredIPVO objects	covered ip list

Table 8 IdObject

Parameter	Type	Description
id	String	ID
name	String	name

Table 9 CoveredIPVO

Parameter	Type	Description
ip	String	ip address
covered_Ip	String	covered ip

Status code: 400

Table 10 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 address group member whose IP address is 2.2.2.2 and name is ceshi to the group whose set_id is 8773c082-2a6c-4529-939a-edc28ef1a67c in project 9d80d070b6d44942af73c9c3d38e0429.

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-items

{
  "set_id" : "8773c082-2a6c-4529-939a-edc28ef1a67c",
  "address_items" : [ {
    "description" : "",
    "name" : "ceshi",
    "address" : "2.2.2.2"
  } ]
}

Example Responses

Status code: 200

Return value for adding an address group member

{
  "data" : {
    "covered_ip" : [ ],
    "items" : [ {
      "id" : "65cb47fc-e666-4af4-8c2c-1fbd2f4b1eae"
    } ]
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CFW.00200001",
  "error_msg" : "empty param"
}

Status Codes

Status Code	Description
200	Return value for adding an address group member
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Address Set Management