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

更新地址组信息

功能介绍

更新地址组信息

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/address-sets/{set_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

set_id

String

地址组id,可通过查询地址组列表接口查询获得,通过返回值中的data.records.set_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参数

参数

是否必选

参数类型

描述

name

String

地址组名称

description

String

地址组描述

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

data

UpdateAddressSetResponseData object

更新地址组返回数据

表6 UpdateAddressSetResponseData

参数

参数类型

描述

id

String

地址组id

name

String

地址组名称

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

将项目id为9d80d070b6d44942af73c9c3d38e0429下的地址组(id为cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16)的名称改为ABCD。

https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16

{
  "name" : "ABCD",
  "description" : ""
}

响应示例

状态码:200

更新地址组返回值

{
  "data" : {
    "id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16"
  }
}

状态码:400

Bad Request,错误的请求

{
  "error_code" : "CFW.00200005",
  "error_msg" : "操作内容不存在"
}

状态码

状态码

描述

200

更新地址组返回值

400

Bad Request,错误的请求

401

Unauthorized,错误的请求

403

Forbidden,禁止访问

404

Not Found,网页未找到

500

Internal Server Error

错误码

请参见错误码