Updating Address Set Information
Function
This API is used to update address group information.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/address-sets/{set_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
set_id |
Yes |
String |
ID of the IP address group |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project. |
fw_instance_id |
No |
String |
Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
IP address group name |
description |
No |
String |
Address group description |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
data |
UpdateAddressSetResponseData object |
Data returned after an address group is updated |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code Minimum: 8 Maximum: 36 |
error_msg |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
In the project 9d80d070b6d44942af73c9c3d38e0429, change the name of the address set whose ID is cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 to ABCD.
https://{Endpoint}/v1/9d80d070b6d44942af73c9c3d38e0429/address-sets/cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16 { "name" : "ABCD", "description" : "" }
Example Responses
Status code: 200
OK
{ "data" : { "id" : "cf18f0b1-0ce7-4eb8-83b6-4b33c8448e16" } }
Status code: 400
Bad Request
{ "error_code" : "CFW.00200005", "error_msg" : "operation content does not exist" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot