文档首页/ 虚拟私有云 VPC/ API参考/ API V3/ IP地址组/ 创建地址组
更新时间：2025-01-07 GMT+08:00
编辑
查看PDF
分享

创建地址组

功能介绍

创建地址组。

接口约束

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

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

获取方式请参见获取项目ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

dry_run

否

Boolean

  • 功能说明：是否只预检此次请求。

  • 取值范围：

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

    • false（默认值）：发送正常请求，并直接创建地址组。

address_group

是

CreateAddressGroupOption object

创建地址组的请求体。
表3 CreateAddressGroupOption

参数

是否必选

参数类型

描述

name

是

String

  • 功能说明：地址组名称。

  • 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。

description

否

String

  • 功能说明：地址组描述信息。

  • 取值范围：0-255个字符，不能包含“<”和“>”。

ip_version

是

Integer

  • 功能说明：地址组ip版本。

  • 取值范围：

    • 4, 表示ipv4地址组。

    • 6，表示ipv6地址组。

max_capacity

否

Integer

  • 功能说明：地址组最大条目数，限制地址组可以包含的地址数量。

  • 取值范围：0-20。

  • 默认值：20。

ip_set

否

Array of strings

  • 功能说明：地址组可包含地址集。

  • 取值范围：可以是单个ip地址，ip地址范围，ip地址cidr。

  • 约束：当前一个地址组ip_set数量限制默认值为20，即配置的ip地址、ip地址范围或ip地址cidr的总数默认限制20。

enterprise_project_id

否

String

  • 功能说明：企业项目ID。创建IP地址组时，给IP地址组绑定企业项目ID。

  • 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。

ip_extra_set

否

Array of IpExtraSetOption objects

  • 功能说明：IP地址组包含的IP列表及其备注信息。

  • 约束：ip数量限制默认20, 与ip_set参数只能二选一。
表4 IpExtraSetOption

参数

是否必选

参数类型

描述

ip

是

String

  • 功能说明：单个IP地址、IP地址范围或ip地址网段，支持IPv4、IPv6。

remarks

否

String

  • 功能说明：IP的备注信息。

  • 取值范围：0-255个字符，不能包含“<”和“>”。

响应参数

状态码： 201

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

address_group

AddressGroup object

创建地址组的响应体。
表6 AddressGroup

参数

参数类型

描述

id

String

  • 功能说明：地址组唯一标识。

  • 取值范围：合法UUID的字符串。

name

String

  • 功能说明：地址组名称。

  • 取值范围：0-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点）。

description

String

  • 功能说明：地址组描述信息。

  • 取值范围：0-255个字符。

  • 约束：不能包含“<”和“>”。

max_capacity

Integer

  • 功能说明：地址组最大条目数，限制地址组可以包含的地址数量。

  • 取值范围：0-20。

  • 默认值：20。

ip_set

Array of strings

  • 功能说明：地址组可包含地址集。

  • 取值范围：可以是单个ip地址，ip地址范围，ip地址cidr。

  • 约束：当前一个地址组ip_set数量限制默认值为20，即配置的ip地址、ip地址范围或ip地址cidr的总数默认限制20。

ip_version

Integer

  • 功能说明：IP地址组ip版本。

  • 取值范围：

    • 4, 表示ipv4地址组。

    • 6, 表示ipv6地址组。

created_at

String

  • 功能说明：地址组创建时间，UTC时间。

  • 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss。

updated_at

String

  • 功能描述：地址组最近一次更新资源的时间，UTC时间。

  • 取值范围：UTC时间格式，yyyy-MM-ddTHH:mm:ss。

tenant_id

String

  • 功能说明：资源所属项目ID。

enterprise_project_id

String

  • 功能说明：企业项目ID。

  • 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。

最大长度：36

tags

Array of ResourceTag objects

  • 功能说明：IP地址组资源标签。

status

String

  • 功能说明：地址组状态。

  • 取值范围：

    • NORMAL：正常

    • UPDATING：更新中

    • UPDATE_FAILED：更新失败

  • 默认值：NORMAL

  • 约束：当地址组处于UPDATING（更新中）状态时，不允许再次更新。

status_message

String

  • 功能说明：地址组状态详情信息。

ip_extra_set

Array of IpExtraSetRespOption objects

  • 功能说明：地址组包含的地址集及其备注信息。
表7 ResourceTag

参数

参数类型

描述

key

String

  • 功能说明：标签键。

  • 约束：同一资源的key值不能重复。

最小长度：1

最大长度：128

value

String

  • 功能说明：标签值。

最大长度：255
表8 IpExtraSetRespOption

参数

参数类型

描述

ip

String

  • 功能说明：单个IP地址、IP地址范围或ip地址网段，支持IPv4、IPv6。

remarks

String

  • 功能说明：IP的备注信息。

  • 取值范围：0-255个字符，不能包含“<”和“>”。

请求示例

  • 创建地址组，命名为AutoTester746010.580123789，指定ip类型为IPv4，地址集包含：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" : ""
  },
  "request_id" : "f568db7a-2675-4271-8747-3e3f1c6381ba"
}

状态码

状态码

描述

201

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

错误码

请参见错误码。

父主题： IP地址组

相关文档