Updating an IP Address Group
Function
This API is used to update an IP address group.
All IP addresses in the IP address group will be overwritten, and the IP addresses that are not included in the ip_list parameter in the request body will be removed.
Each IP address group can contain a single IP address, IP address ranges, or CIDR blocks. Each IP address range must be in the format of ip-ip, for example, 10.12.3.1-10.12.3.10. Both IPv4 and IPv6 addresses are supported.
0.0.0.0 will be considered the same as 0.0.0.0/32. If you enter both 0.0.0.0 and 0.0.0.0/32, only one will be kept. 0:0:0:0:0:0:0:1 will be considered the same as ::1 and ::1/128. If you enter 0:0:0:0:0:0:0:1, ::1 and ::1/128, only one will be kept.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/elb/ipgroups/{ipgroup_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ipgroup_id |
Yes |
String |
Specifies the ID of the IP address group. |
project_id |
Yes |
String |
Specifies the project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the token used for IAM authentication. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ipgroup |
Yes |
UpdateIpGroupOption object |
Specifies the request body for updating the IP address group. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
description |
No |
String |
Provides supplementary information about the IP address group. |
name |
No |
String |
Specifies the IP address group name. |
ip_list |
No |
Array of UpadateIpGroupIpOption objects |
Lists the IP addresses in the IP address group. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ip |
Yes |
String |
Specifies the IP addresses or IP address ranges in the IP address group. IPv4 and IPv6 addresses are supported. An IP address range can be in the format of ip-ip, for example, 192.168.1.2-192.168.2.253 or 2001:0DB8:02de::0e12-2001:0DB8:02de::0e13. The end IP address must be greater than the start IP address. Specified IP addresses that are not already in the IP address group will be added; existing ones will have their descriptions updated. |
description |
No |
String |
Provides remarks about the IP address group. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
ipgroup |
IpGroup object |
Specifies the response body for updating the IP address group. |
request_id |
String |
Specifies the request ID. Note: The value is automatically generated. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the ID of the IP address group. |
name |
String |
Specifies the IP address group name. |
description |
String |
Provides supplementary information about the IP address group. |
ip_list |
Array of IpInfo objects |
Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address. |
listeners |
Array of ListenerRef objects |
Lists the IDs of listeners with which the IP address group is associated. |
project_id |
String |
Specifies the project ID of the IP address group. |
enterprise_project_id |
String |
Specifies the ID of the enterprise project that the IP address group belongs to. |
created_at |
String |
Specifies the time when the IP address group was created. |
updated_at |
String |
Specifies the time when the IP address group was updated. |
Example Requests
Changing all the IP addresses in an IP address group
PUT https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups/8722e0e0-9cc9-4490-9660-8c9a5732fbb0 { "ipgroup" : { "name" : "test_ipg", "ip_list" : [ { "ip" : "192.168.1.123" }, { "ip" : "192.168.3.0/24", "description" : "test_ip" } ] } }
Example Responses
Status code: 200
Successful request.
{ "ipgroup" : { "description" : "", "id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0", "name" : "test_ipg", "project_id" : "45977fa2dbd7482098dd68d0d8970117", "ip_list" : [ { "ip" : "192.168.1.123", "description" : "" }, { "ip" : "192.168.3.0/24", "description" : "test_ip" } ], "listeners" : [ { "id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd" }, { "id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c" } ], "created_at" : "2018-01-16T03:19:16", "updated_at" : "2018-01-16T03:19:16" } }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request. |
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