更新时间:2024-12-05 GMT+08:00

添加地址组

功能介绍

添加地址组

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/address-set

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目id,用户支持企业项目后,由企业项目生成的id。

fw_instance_id

String

防火墙实例id,创建云防火墙后用于标志防火墙由系统自动生成的标志id,可通过调用查询防火墙实例接口,默认情况下,fw_instance_Id为空时,返回账号下第一个墙的信息;fw_instance_Id非空时,返回与fw_instance_Id对应墙的信息。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

表4 请求Body参数

参数

是否必选

参数类型

描述

object_id

String

互联网边界防护对象id,可通过调用查询防火墙实例接口,type为0的为互联网边界防护对象id。

name

String

地址组名称

description

String

地址组描述

address_type

Integer

地址类型0 ipv4,1 ipv6

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

data

IdObject object

添加地址组返回数据

表6 IdObject

参数

参数类型

描述

id

String

id值

name

String

名称

状态码: 400

表7 响应Body参数

参数

参数类型

描述

data

data object

响应体

trace_id

String

trace id

表8 data

参数

参数类型

描述

id

String

标识ID

请求示例

添加项目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

OK

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

状态码: 400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码