文档首页/ 云防火墙 CFW/ API参考/ API/ 防火墙管理/ 更改防火墙名称
更新时间：2025-08-28 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更改防火墙名称

功能介绍

更改防火墙名称

调用方法

请参见如何调用API。

URI

PUT /v1/{project_id}/firewall/name

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以从调API处获取，也可以从控制台获取。项目ID获取方式

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

fw_instance_id

是

String

参数解释：

防火墙ID，用户创建防火墙实例后产生的唯一ID，配置后可区分不同防火墙，可通过防火墙ID获取方式获取

约束限制：

不涉及

取值范围：

32位UUID

默认取值：

不涉及

请求参数

表3 请求Body参数

参数

是否必选

参数类型

描述

fw_instance_name

是

String

参数解释：

防火墙名称

约束限制：

防火墙名称为中英文，包含数字，下划线，中划线，长度为1-48

取值范围：

不涉及

默认取值：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

data object

参数解释：

响应信息

取值范围：

不涉及
表5 data

参数

参数类型

描述

id

String

参数解释：

防火墙ID，可通过防火墙ID获取

方式获取

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

String

参数解释：

防火墙名称

约束限制：

防火墙名称为中英文，包含数字，下划线，中划线，长度为1-48

取值范围：

不涉及

默认取值：

不涉及

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码

取值范围：

不涉及

error_msg

String

参数解释：

错误描述

取值范围：

不涉及

请求示例

修改项目ID为eb7accd78ea845078275b2ad5280a109，防火墙ID为8a996d43-75bd-48b4-b1b8-de0706b72b8f的防火墙名称

https://{Endpoint}/v1/5de88e3e18124fa99675fb51ceceaa31/firewall/name?fw_instance_id=d2736642-009e-47e6-b66e-cc4355a9f8c8

{
  "fw_instance_name" : "CFW"
}

响应示例

状态码：200

OK

{
  "data" : {
    "id" : "d2736642-009e-47e6-b66e-cc4355a9f8c8",
    "name" : "CFW"
  }
}

状态码：400

Bad Request

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

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 防火墙管理

相关文档