更新对象配置描述
功能介绍
更新对象配置描述
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/config/object/description
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID，可以从调API处获取，也可以从控制台获取。项目ID获取方式 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。可通过如何获取用户Token获取。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
description | 否 | String | 成员描述 |
fw_instance_id | 否 | String | 防火墙ID，可通过防火墙ID获取方式获取 |
item_id | 否 | String | 成员id，地址组成员id，可通过查询地址组成员接口查询获得，通过返回值中的data.records.item_id（.表示各对象之间层级的区分）获得。服务组成员id，可通过查询服务成员列表接口查询获得，通过返回值中的data.records.item_id（.表示各对象之间层级的区分）获得。域名id可通过获取域名组下域名列表接口查询获得，通过返回值中的data.records.domain_address_id（.表示各对象之间层级的区分）获得。 |
set_id | 否 | String | 组id，地址组id，可通过查询地址组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。服务组id，可通过获取服务组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。域名组id，可通过查询域名组列表接口查询获得，通过返回值中的data.records.set_id（.表示各对象之间层级的区分）获得。 |
type | 否 | String | 组类型，包含：地址组ADDR_SET，服务组SERV_SET，域名组DOMAIN_SET，URL组URL_SET |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
data | String | 成员id |
请求示例
更新项目id为408972e72dcd4c1a9b033e955802a36b下的地址组成员描述，防火墙ID为b273e6c6-59f3-44cc-9a0d-89824814b474，地址组id为4fc0f061-3f3f-4a16-821c-30d7f6fb895d，地址组成员id为0eac72c9-da3e-4386-b2f2-eb7dbc37d25f，描述为test
https://{Endpoint}/v1/408972e72dcd4c1a9b033e955802a36b/config/object/description
{
"set_id" : "4fc0f061-3f3f-4a16-821c-30d7f6fb895d",
"type" : "ADDR_SET",
"item_id" : "0eac72c9-da3e-4386-b2f2-eb7dbc37d25f",
"description" : "test",
"fw_instance_id" : "b273e6c6-59f3-44cc-9a0d-89824814b474"
} 响应示例
状态码：200
更新对象配置描述返回值
{
"data" : "0eac72c9-da3e-4386-b2f2-eb7dbc37d25f"
} 状态码
状态码 | 描述 |
|---|---|
200 | 更新对象配置描述返回值 |
错误码
请参见错误码。
