更新时间:2025-11-21 GMT+08:00

添加地址组成员

功能介绍

添加地址组成员

调用方法

请参见如何调用API。

URI

POST /v1/{project_id}/address-items

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID,可以从调API处获取,也可以从控制台获取。项目ID获取方式

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID,用户根据组织规划企业项目,对应的ID为企业项目ID,用户未开启企业项目时为0

fw_instance_id

否

String

防火墙ID,可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。可通过如何获取用户Token获取。

表4 请求Body参数

参数

是否必选

参数类型

描述

set_id

否

String

地址组id,可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_id(.表示各对象之间层级的区分)获得。

address_items

否

Array of address_items objects

地址组成员列表

表5 address_items

参数

是否必选

参数类型

描述

address_type

否

Integer

地址类型0 ipv4,1 ipv6

address

是

String

ip

description

否

String

地址组成员描述

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

data

AddressItems object

添加地址组成员返回数据

表7 AddressItems

参数

参数类型

描述

items

Array of AddressItemIdWithoutName objects

地址组成员id列表

covered_ip

Array of CoveredIPVO objects

覆盖IP列表

表8 AddressItemIdWithoutName

参数

参数类型

描述

id

String

地址组成员id

表9 CoveredIPVO

参数

参数类型

描述

ip

String

IP地址

covered_Ip

String

覆盖IP地址。

状态码:400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

给项目id为9d80d070b6d44942af73c9c3d38e0429的项目下的set_id为8773c082-2a6c-4529-939a-edc28ef1a67c添加IP地址为2.2.2.2,名称为ceshi的地址组成员

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

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

响应示例

状态码:200

添加地址组成员返回值

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

状态码:400

Bad Request,错误的请求

{
  "error_code" : "CFW.00200001",
  "error_msg" : "空参数错误"
}

状态码

状态码

描述

200

添加地址组成员返回值

400

Bad Request,错误的请求

401

Unauthorized,错误的请求

403

Forbidden,禁止访问

404

Not Found,网页未找到

500

Internal Server Error

错误码

请参见错误码。