Help Center/Cloud Firewall/API Reference (Kuala Lumpur Region)/API/Address Group Management/Updating the Object Configuration Description
Updated on 2025-11-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating the Object Configuration Description

Function

This API is used to update the object configuration description.

URI

PUT /v1/{project_id}/config/object/description

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by calling an API or from the console. For details, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

description

No

String

Member description.

fw_instance_id

No

String

Firewall ID, which can be obtained by referring to Obtaining a Firewall ID.

item_id

No

String

Address group member ID, which can be obtained by calling the API for querying address group members. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects). Service group member ID, which can be obtained by calling the API for querying the service group member list. Find the value in data.records.item_id (The period [.] is used to separate different levels of objects). Domain name ID. It can be obtained by calling the API for querying the domain name list under a domain name group. Find the value in data.records.domain_address_id (The period [.] is used to separate different levels of objects).

set_id

No

String

Address group ID, which can be obtained by calling the API for querying the address group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). Service group ID, which can be obtained by calling the API for querying the service group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects). Domain name group ID, which can be obtained by calling the API for querying the domain name group list. Find the value in data.records.set_id (The period [.] is used to separate different levels of objects).

type

No

String

Group type: ADDR_SET (address group), SERV_SET (service group), DOMAIN_SET (domain name group), or URL_SET (URL group).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Object

Member ID.

Example Requests

Update the description of the address group member in the project whose ID is 408972e72dcd4c1a9b033e955802a36b. The firewall ID is b273e6c6-59f3-44cc-9a0d-89824814b474, the address group ID is 4fc0f061-3f3f-4a16-821c-30d7f6fb895d, the address group member ID is 0eac72c9-da3e-4386-b2f2-eb7dbc37d25f, and the description is 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"
}

Example Responses

Status code: 200

OK

{
  "data" : "0eac72c9-da3e-4386-b2f2-eb7dbc37d25f"
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.