更新时间:2025-08-19 GMT+08:00

创建地址组

功能介绍

IP地址组是一个或者多个IP地址的集合,可关联至安全组、网络ACL,用于简化网络架构中IP地址的配置和管理。用户可以创建IP地址组来统一管理IP网段和单个IP地址。

接口约束

当前每租户的地址组配额默认值为50。

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/vpc/address-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

IP地址组所属的项目ID。获取方式请参见获取项目ID

取值范围

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

dry_run

Boolean

参数解释

是否只预检此次请求。

约束限制

不涉及。

取值范围

  • true:发送检查请求,不会创建IP地址组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回响应码202。

  • false:发送正常请求,并直接创建IP地址组。

默认取值

false

address_group

CreateAddressGroupOption object

参数解释

创建IP地址组的请求体。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表3 CreateAddressGroupOption

参数

是否必选

参数类型

描述

name

String

参数解释

IP地址组的名称。

约束限制

1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。

取值范围

不涉及。

默认取值

不涉及。

description

String

参数解释

IP地址组的描述信息。

约束限制

0-255个字符,不能包含“<”和“>”。

取值范围

不涉及。

默认取值

不涉及。

ip_version

Integer

参数解释

IP地址组的IP版本。

约束限制

不涉及。

取值范围

  • 4:表示IPv4地址组。

  • 6:表示IPv6地址组。

默认取值

不涉及。

max_capacity

Integer

参数解释

IP地址组的最大条目数,限制IP地址组可以包含的IP地址数量。

约束限制

不涉及。

取值范围

0-20

默认取值

20

ip_set

Array of strings

参数解释

IP地址组包含的IP地址集,支持IPv4和IPv6。

约束限制

  • 当前一个IP地址组的ip_set数量限制默认值为20,即配置的单个IP地址、IP地址范围或IP网段的条目总数默认限制20。

  • 请求时,ip_set参数与ip_extra_set参数不能同时传入,如果用户需要为IP条目添加备注信息,请选择ip_extra_set参数作为输入。

取值范围

IP地址集中的元素可以是:

  • 单个IP地址,如192.168.21.25。

  • IP地址范围,如192.168.21.25-192.168.21.30。

  • IP网段,如192.168.21.0/24。

默认取值

不涉及。

enterprise_project_id

String

参数解释

IP地址组所属的企业项目ID。创建IP地址组时,给IP地址组绑定企业项目ID。

约束限制

  • 最大长度36字节。

  • 带“-”连字符的UUID格式,或者是字符串“0”。

取值范围

不涉及。

默认取值

“0”表示默认企业项目。

ip_extra_set

Array of IpExtraSetOption objects

参数解释

IP地址组包含的IP地址及其备注信息。列表中包含多个IP条目对象,每个IP条目对象包含一个IP条目和一个备注信息,IP条目和ip_set中的列表元素一样,备注信息可以用来标注IP的用途。

约束限制

  • IP条目对象数量默认限制20。

  • 请求时,ip_set参数与ip_extra_set参数不能同时传入,如果用户需要为IP条目添加备注信息,请选择ip_extra_set参数作为输入。

取值范围

不涉及。

默认取值

不涉及。

表4 IpExtraSetOption

参数

是否必选

参数类型

描述

ip

String

参数解释

IP地址集中包含的IP条目,支持IPv4和IPv6。

约束限制

不涉及。

取值范围

  • 单个IP地址,如192.168.21.25。

  • IP地址范围,如192.168.21.25-192.168.21.30。

  • IP网段,如192.168.21.0/24。

默认取值

不涉及。

remarks

String

参数解释

IP条目的备注信息。

约束限制

0-255个字符,不能包含“<”和“>”。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:201

表5 响应Body参数

参数

参数类型

描述

request_id

String

参数解释

请求ID。

取值范围

不涉及。

address_group

AddressGroup object

参数解释

创建IP地址组的响应体。

取值范围

不涉及。

表6 AddressGroup

参数

参数类型

描述

id

String

参数解释

IP地址组的资源ID。IP地址组创建成功后,会生成一个IP地址组ID,是IP地址组对应的唯一标识。

取值范围

带“-”的标准UUID格式。

name

String

参数解释

IP地址组的名称。

取值范围

1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点)。

description

String

参数解释

IP地址组的描述信息。

取值范围

0-255个字符,不能包含“<”和“>”。

max_capacity

Integer

参数解释

IP地址组支持的最大IP条目数,限制IP地址组可以包含的IP地址数量。

取值范围

0-20,默认20。

ip_set

Array of strings

参数解释

IP地址组包含的IP地址集,支持IPv4和IPv6。

取值范围

IP地址集中的元素可以是:

  • 单个IP地址,如192.168.21.25。

  • IP地址范围,如192.168.21.25-192.168.21.30。

  • IP网段,如192.168.21.0/24。

ip_version

Integer

参数解释

IP地址组的IP版本。

取值范围

  • 4:表示IPv4地址组。

  • 6:表示IPv6地址组。

created_at

String

参数解释

IP地址组的创建时间。

取值范围

UTC时间格式,yyyy-MM-ddTHH:mm:ss。

updated_at

String

参数解释

IP地址组的最近一次的更新时间。

取值范围

UTC时间格式,yyyy-MM-ddTHH:mm:ss。

tenant_id

String

参数解释

IP地址组所属的项目ID。

取值范围

不涉及。

enterprise_project_id

String

参数解释

IP地址组所属的企业项目ID。

取值范围

最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。

tags

Array of ResponseTag objects

参数解释

IP地址组的标签信息,包括标签键和标签值,可用来分类和标识资源。详情请参见Tag对象。

取值范围

不涉及。

status

String

参数解释

IP地址组的状态,当IP地址组处于UPDATING(更新中)状态时,不允许再次更新。

取值范围

  • NORMAL:正常,默认值。

  • UPDATING:更新中。

  • UPDATE_FAILED:更新失败。

status_message

String

参数解释

IP地址组的状态详情信息。

取值范围

不涉及。

ip_extra_set

Array of IpExtraSetRespOption objects

参数解释

IP地址组包含的IP地址及其备注信息。

取值范围

不涉及。

表7 ResponseTag

参数

参数类型

描述

key

String

参数解释

标签键。

取值范围

  • 最大长度128个unicode字符, key不能为空。

  • 同一资源的key不能重复。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、中划线(-)

    • 中文字符

value

String

参数解释

标签值。

取值范围

  • 每个值最大长度255个unicode字符,value可以为空。

  • 可以包含的字符范围:

    • 英文字母

    • 数字

    • 特殊字符:下划线(_)、中划线(-)、点(.)

    • 中文字符

表8 IpExtraSetRespOption

参数

参数类型

描述

ip

String

参数解释

IP地址集中包含的IP条目,支持IPv4和IPv6。

取值范围

  • 单个IP地址,如192.168.21.25。

  • IP地址范围,如192.168.21.25-192.168.21.30。

  • IP网段,如192.168.21.0/24。

remarks

String

参数解释

IP条目的备注信息。

取值范围

0-255个字符,不能包含“<”和“>”。

请求示例

创建IP地址组,命名为AutoTester746010.580123789,指定IP类型为IPv4,IP地址集包含:192.168.3.2、192.168.3.40、192.168.3.20-192.168.3.100、192.168.5.0/24。

POST https://{{endpoint}}/v3/b2782e6708b8475c993e6064bc456bf8/vpc/address-groups

{
  "address_group" : {
    "ip_version" : 4,
    "name" : "AutoTester746010.580123789",
    "ip_set" : [ "192.168.3.2", "192.168.3.40", "192.168.3.20-192.168.3.100", "192.168.5.0/24" ],
    "description" : "test",
    "enterprise_project_id" : "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
    "max_capacity" : 20
  }
}

响应示例

状态码:201

POST操作正常返回,更多状态码请参见状态码

{
  "address_group" : {
    "id" : "dd18a501-fcd5-4adc-acfe-b0e2384baf08",
    "name" : "AutoTester746010.580123789",
    "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.40", "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.40",
      "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:06:38.000+00:00",
    "description" : "test",
    "status" : "NORMAL",
    "status_message" : "",
    "tags" : [ ]
  },
  "request_id" : "f568db7a-2675-4271-8747-3e3f1c6381ba"
}

SDK代码示例

SDK代码示例如下。

创建IP地址组,命名为AutoTester746010.580123789,指定IP类型为IPv4,IP地址集包含:192.168.3.2、192.168.3.40、192.168.3.20-192.168.3.100、192.168.5.0/24。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.vpc.v3.region.VpcRegion;
import com.huaweicloud.sdk.vpc.v3.*;
import com.huaweicloud.sdk.vpc.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateAddressGroupSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        VpcClient client = VpcClient.newBuilder()
                .withCredential(auth)
                .withRegion(VpcRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateAddressGroupRequest request = new CreateAddressGroupRequest();
        CreateAddressGroupRequestBody body = new CreateAddressGroupRequestBody();
        List<String> listAddressGroupIpSet = new ArrayList<>();
        listAddressGroupIpSet.add("192.168.3.2");
        listAddressGroupIpSet.add("192.168.3.40");
        listAddressGroupIpSet.add("192.168.3.20-192.168.3.100");
        listAddressGroupIpSet.add("192.168.5.0/24");
        CreateAddressGroupOption addressGroupbody = new CreateAddressGroupOption();
        addressGroupbody.withName("AutoTester746010.580123789")
            .withDescription("test")
            .withIpVersion(4)
            .withIpSet(listAddressGroupIpSet)
            .withMaxCapacity(20)
            .withEnterpriseProjectId("0aad99bc-f5f6-4f78-8404-c598d76b0ed2");
        body.withAddressGroup(addressGroupbody);
        request.withBody(body);
        try {
            CreateAddressGroupResponse response = client.createAddressGroup(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

创建IP地址组,命名为AutoTester746010.580123789,指定IP类型为IPv4,IP地址集包含:192.168.3.2、192.168.3.40、192.168.3.20-192.168.3.100、192.168.5.0/24。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkvpc.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = VpcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(VpcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateAddressGroupRequest()
        listIpSetAddressGroup = [
            "192.168.3.2",
            "192.168.3.40",
            "192.168.3.20-192.168.3.100",
            "192.168.5.0/24"
        ]
        addressGroupbody = CreateAddressGroupOption(
            name="AutoTester746010.580123789",
            description="test",
            ip_version=4,
            ip_set=listIpSetAddressGroup,
            max_capacity=20,
            enterprise_project_id="0aad99bc-f5f6-4f78-8404-c598d76b0ed2"
        )
        request.body = CreateAddressGroupRequestBody(
            address_group=addressGroupbody
        )
        response = client.create_address_group(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建IP地址组,命名为AutoTester746010.580123789,指定IP类型为IPv4,IP地址集包含:192.168.3.2、192.168.3.40、192.168.3.20-192.168.3.100、192.168.5.0/24。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := vpc.NewVpcClient(
        vpc.VpcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateAddressGroupRequest{}
	var listIpSetAddressGroup = []string{
        "192.168.3.2",
	    "192.168.3.40",
	    "192.168.3.20-192.168.3.100",
	    "192.168.5.0/24",
    }
	descriptionAddressGroup:= "test"
	maxCapacityAddressGroup:= int32(20)
	enterpriseProjectIdAddressGroup:= "0aad99bc-f5f6-4f78-8404-c598d76b0ed2"
	addressGroupbody := &model.CreateAddressGroupOption{
		Name: "AutoTester746010.580123789",
		Description: &descriptionAddressGroup,
		IpVersion: int32(4),
		IpSet: &listIpSetAddressGroup,
		MaxCapacity: &maxCapacityAddressGroup,
		EnterpriseProjectId: &enterpriseProjectIdAddressGroup,
	}
	request.Body = &model.CreateAddressGroupRequestBody{
		AddressGroup: addressGroupbody,
	}
	response, err := client.CreateAddressGroup(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

201

POST操作正常返回,更多状态码请参见状态码

错误码

请参见错误码