文档首页/云防火墙 CFW/API参考 (联盟区域) /API/地址组管理/添加地址组
更新时间：2025-12-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

添加地址组

功能介绍

添加地址组

URI

POST /v1/{project_id}/address-set

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

企业项目ID，用户根据组织规划企业项目，对应的ID为企业项目ID，可通过如何获取企业项目ID获取，用户未开启企业项目时为0

fw_instance_id

否

String

防火墙id，可通过防火墙ID获取方式获取

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

Content-Type

是

String

内容类型，只有application/json的值是适用的

表4 请求Body参数

参数

是否必选

参数类型

描述

object_id

是

String

防护对象id，是创建云防火墙后用于区分互联网边界防护和VPC边界防护的标志id，可通过调用查询防火墙实例接口获得，通过返回值中的data.records.protect_objects.object_id（.表示各对象之间层级的区分）获得，注意type为0的为互联网边界防护对象id，type为1的为VPC边界防护对象id，type可通过data.records.protect_objects.type（.表示各对象之间层级的区分）获得

name

是

String

地址组名称

description

否

String

地址组描述

address_type

否

Integer

地址Internet协议类型0 ipv4，1 ipv6

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

data

AddressSetId object

添加地址组返回数据

表6 AddressSetId

参数

参数类型

描述

id

String

地址组id

name

String

地址组名称

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

添加项目id为14181c1245cf4fd786824efe1e2b9388，防护对象 id为1530de8a-522d-4771-9067-9fa4e2f53b48，名称为ceshi的IPv4的地址组。

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

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

响应示例

状态码：200

添加地址组返回值

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

状态码：400

Bad Request

{
  "error_code" : "CFW.00900020",
  "error_msg" : "地址组超过最大数量限制"
}

状态码

状态码

描述

200

添加地址组返回值

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题：地址组管理