yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
yexinru_ucs_apiyaml
doc-exports/docs/vpc/api-ref/vpc_apiv3_0025.html
fanqinying 7655950d89 VPC API 20251113 version 
Reviewed-by: Hajba, László Antal <laszlo-antal.hajba@t-systems.com>
Co-authored-by: fanqinying <fanqinying@huawei.com>
Co-committed-by: fanqinying <fanqinying@huawei.com>
2026-04-10 09:21:14 +00:00

28 KiB
Raw Permalink Blame History

Updating an IP Address Group

Function

This API is used to update information about an IP address group, including the IP address group name and IP addresses.

URI

PUT /v3/{project_id}/vpc/address-groups/{address_group_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

address_group_id

Yes

String

Definition:

ID of an IP address group.

Range:

N/A

project_id

Yes

String

Definition:

ID of the project that an IP address group belongs to.

Range:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

dry_run

No

Boolean

Definition:

Whether to only check the request.

Constraints:

N/A

Range:

  • true: A check request will be sent and the IP address group will not be updated. Check items include mandatory parameters, request format, and constraints. If the check fails, an error will be returned. If the check succeeds, response code 202 will be returned.

  • false: A request will be sent and the IP address group will be updated.

Default Value:

false

address_group

Yes

UpdateAddressGroupOption object

Definition:

Request body for updating an IP address group.

Constraints:

N/A

Range:

N/A

Default Value:

N/A
Table 3 UpdateAddressGroupOption

Parameter

Mandatory

Type

Description

name

No

String

Definition:

The name of an IP address group.

Constraints:

The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods.

Range:

N/A

Default Value:

N/A

description

No

String

Definition:

Description about an IP address group.

Constraints:

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

Range:

N/A

Default Value:

N/A

ip_set

No

Array of strings

Definition:

IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported.

Constraints:

  • The default maximum number of IP address sets, including IP addresses, IP address ranges, and CIDR blocks, in an IP address group is 20.

  • ip_set and ip_extra_set cannot be both specified in a request.

Range:

An IP address entry in an IP address set can be:

  • A single IP address, for example, 192.168.21.25

  • An IP address range, for example, 192.168.21.25-192.168.21.30

  • A CIDR block, for example, 192.168.21.0/24

Default Value:

N/A

ip_extra_set

No

Array of IpExtraSetOption objects

Definition:

IP address entries in an IP address group and their remarks.

Constraints:

  • By default, the maximum number of IP address entries is 20.

  • ip_set and ip_extra_set cannot be both specified in a request.

Range:

N/A

Default Value:

N/A
Table 4 IpExtraSetOption

Parameter

Mandatory

Type

Description

ip

Yes

String

Definition:

IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported.

Constraints:

N/A

Range:

  • A single IP address, for example, 192.168.21.25

  • An IP address range, for example, 192.168.21.25-192.168.21.30

  • A CIDR block, for example, 192.168.21.0/24

Default Value:

N/A

remarks

No

String

Definition:

Remarks of an IP address entry.

Constraints:

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

Range:

N/A

Default Value:

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Definition:

Request ID.

Range:

N/A

address_group

AddressGroup object

Definition:

Response body for updating an IP address group.

Range:

N/A
Table 6 AddressGroup

Parameter

Type

Description

id

String

Definition:

ID of an IP address group. After an IP address group is created, an IP address group ID is generated, which uniquely identifies the IP address group.

Range:

The value is in UUID format with hyphens (-).

name

String

Definition:

The name of an IP address group.

Range:

The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods.

description

String

Definition:

Description about an IP address group.

Range:

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

max_capacity

Integer

Definition:

Maximum number of IP address entries in an IP address group.

Range:

The value can be from 0 to 20. The default value is 20.

ip_set

Array of strings

Definition:

IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported.

Range:

An IP address entry in an IP address set can be:

  • A single IP address, for example, 192.168.21.25

  • An IP address range, for example, 192.168.21.25-192.168.21.30

  • A CIDR block, for example, 192.168.21.0/24

ip_version

Integer

Definition:

IP address version of an IP address group.

Range:

  • 4: IPv4 address group

  • 6: IPv6 address group

created_at

String

Definition:

Time when an IP address group was created.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss.

updated_at

String

Definition:

Time when an IP address group was last updated.

Range:

The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss.

tenant_id

String

Definition:

ID of the project that an IP address group belongs to.

Range:

N/A

enterprise_project_id

String

Definition:

ID of the enterprise project that an IP address group belongs to.

Range:

The value is 0 or a string that contains a maximum of 36 characters in UUID format with hyphens (-). 0 indicates the default enterprise project.

tags

Array of ResponseTag objects

Definition:

Tags of an IP address group, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects.

Range:

N/A

status

String

Definition:

Status of an IP address group. If the IP address group is in the UPDATING state, it cannot be updated again.

Range:

  • NORMAL: normal (default value)

  • UPDATING: being updated

  • UPDATE_FAILED: update failed

status_message

String

Definition:

Details about the IP address group status.

Range:

N/A

ip_extra_set

Array of IpExtraSetRespOption objects

Definition:

IP address entries in an IP address group and their remarks.

Range:

N/A
Table 7 ResponseTag

Parameter

Type

Description

key

String

Definition:

Tag key.

Range:

  • A tag key can contain a maximum of 128 Unicode characters and cannot be left blank.

  • Each tag key of a resource must be unique.

  • The value can contain:

    • Letters

    • Digits

    • Special characters: underscores (_), periods (.), colons (:), plus signs (+), hyphens (-), at signs (@), and equal signs (=)

value

String

Definition:

Tag value.

Range:

  • Each value can contain a maximum of 255 Unicode characters and can be left blank.

  • The value can contain:

    • Letters

    • Digits

    • Special characters: underscores (_), colons (:), plus signs (+), hyphens (-), at signs (@), and equal signs (=)
Table 8 IpExtraSetRespOption

Parameter

Type

Description

ip

String

Definition:

IP address entries in an IP address group. Both IPv4 and IPv6 address entries are supported.

Range:

  • A single IP address, for example, 192.168.21.25

  • An IP address range, for example, 192.168.21.25-192.168.21.30

  • A CIDR block, for example, 192.168.21.0/24

remarks

String

Definition:

Remarks of an IP address entry.

Range:

The value can contain 0 to 255 characters and cannot contain angle brackets (< or >).

Example Requests

Change the IP set and description of the IP address group whose ID is dd18a501-fcd5-4adc-acfe-b0e2384baf08. Change the IP address group name to vkvgykvsvhjaaaa1.

PUT https://{endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups/dd18a501-fcd5-4adc-acfe-b0e2384baf08

{
  "address_group" : {
    "name" : "vkvgykvsvhjaaaa1",
    "ip_set" : [ "192.168.3.2", "192.168.3.43", "192.168.3.20-192.168.3.100", "192.168.5.0/24" ],
    "description" : "xxxxxxxxxx"
  }
}

Example Responses

Status code: 200

Normal response to the PUT operation. For more status codes, see Status Codes.

{
  "address_group" : {
    "id" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
    "name" : "vkvgykvsvhjaaaa1",
    "tenant_id" : "b2782e6708b8475c993e6064bc456bf8",
    "ip_version" : 4,
    "max_capacity" : 20,
    "ip_set" : [ "192.168.5.0/24", "192.168.3.20-192.168.3.100", "192.168.3.43", "192.168.3.2" ],
    "ip_extra_set" : [ {
      "ip" : "192.168.5.0/24",
      "remarks" : null
    }, {
      "ip" : "192.168.3.20-192.168.3.100",
      "remarks" : null
    }, {
      "ip" : "192.168.3.43",
      "remarks" : null
    }, {
      "ip" : "192.168.3.2",
      "remarks" : null
    } ],
    "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
    "created_at" : "2019-06-28T02:06:38.000+00:00",
    "updated_at" : "2019-06-28T02:14:01.000+00:00",
    "description" : "xxxxxxxxxx",
    "status" : "NORMAL",
    "status_message" : "",
    "tags" : [ ]
  },
  "request_id" : "5bbd1640-fa68-4362-9a5c-30c4809958e0"
}

Status Codes

Status Code

Description

200

Normal response to the PUT operation. For more status codes, see Status Codes.

Error Codes

See Error Codes.

Parent topic: IP Address Group