文档首页/ 虚拟私有云 VPC/ API参考/ API V3/ 辅助弹性网卡/ 创建辅助弹性网卡
更新时间：2024-10-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建辅助弹性网卡

功能介绍

创建辅助弹性网卡。

调试

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

URI

POST /v3/{project_id}/vpc/sub-network-interfaces

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

dry_run

否

Boolean

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

  • 取值范围：

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

    • false（默认值）：发送正常请求，并直接创建辅助弹性网卡。

sub_network_interface

是

CreateSubNetworkInterfaceOption object

创建辅助弹性网卡请求体对象。
表3 CreateSubNetworkInterfaceOption

参数

是否必选

参数类型

描述

virsubnet_id

是

String

  • 功能说明：虚拟子网ID。

  • 取值范围：标准UUID。

vlan_id

否

String

  • 功能说明：辅助弹性网卡的VLAN ID。

  • 取值范围：1-4094。

  • 约束：同一个宿主网络接口下唯一。

parent_id

是

String

  • 功能说明：宿主网络接口的ID。

  • 取值范围：标准UUID。

  • 约束：必须是实际存在的端口ID。

description

否

String

  • 功能说明：辅助弹性网卡的描述信息。

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

ipv6_enable

否

Boolean

  • 功能说明：辅助弹性网卡是否启用ipv6地址。

  • 取值范围：true（开启)，false（关闭）。

  • 默认值：false。

private_ip_address

否

String

  • 功能说明：辅助弹性网卡的私有IPv4地址。

  • 取值范围：必须在虚拟子网的网段内，不填则随机在虚拟子网网段内随机分配。

ipv6_ip_address

否

String

  • 功能说明：辅助弹性网卡的IPv6地址。

  • 取值范围：不填则随机分配。

security_groups

否

Array of strings

  • 功能说明：安全组的ID列表，例如："security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]。

  • 取值范围：默认值为系统默认安全组。

project_id

否

String

  • 功能说明：辅助弹性网卡所属的项目ID。

  • 取值范围：标准UUID。

  • 约束：只有管理员有权限指定。

allowed_address_pairs

否

Array of AllowAddressPair objects

  • 扩展属性：IP/Mac对列表，allow_address_pair参见“allow_address_pair对象”表。

  • 使用说明：

    • IP地址不允许为 “0.0.0.0”。

    • 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。

    • 硬件SDN环境不支持ip_address属性配置为CIDR格式。
表4 AllowAddressPair

参数

是否必选

参数类型

描述

ip_address

否

String

  • 功能说明：

    • IP地址不支持0.0.0.0。

    • 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。

mac_address

否

String

  • 功能说明：MAC地址。

响应参数

状态码： 201

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

sub_network_interface

SubNetworkInterface object

辅助弹性网卡的响应体。
表6 SubNetworkInterface

参数

参数类型

描述

id

String

  • 功能说明：辅助弹性网卡的唯一标识。

  • 取值范围：带(-)的标准UUID。

virsubnet_id

String

  • 功能说明：虚拟子网ID。

  • 取值范围：标准UUID。

private_ip_address

String

  • 功能说明：辅助弹性网卡的私有IPv4地址。

  • 取值范围：必须在虚拟子网的网段内，不填则随机在虚拟子网网段内随机分配。

ipv6_ip_address

String

  • 功能说明：辅助弹性网卡的IPv6地址。

mac_address

String

  • 功能说明：辅助弹性网卡的mac地址。

  • 取值范围：合法的mac地址，系统随机分配。

parent_device_id

String

  • 功能说明：设备ID。

  • 取值范围：标准UUID。

parent_id

String

  • 功能说明：宿主网络接口的ID。

  • 取值范围：标准UUID。

description

String

  • 功能说明：辅助弹性网卡的描述信息。

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

vpc_id

String

  • 功能说明：辅助弹性网卡所属的VPC_ID。

  • 取值范围：标准UUID。

vlan_id

Integer

  • 功能说明：辅助弹性网卡的VLAN ID。

  • 取值范围：1-4094。

  • 约束：同一个宿主网络接口下唯一。

security_groups

Array of strings

  • 功能说明：安全组的ID列表，例如："security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]。

  • 取值范围：默认值为系统默认安全组。

tags

Array of ResourceTag objects

  • 功能说明：辅助弹性网卡的标签列表。

project_id

String

  • 功能说明：辅助弹性网卡所属项目ID。

created_at

String

  • 功能说明：辅助弹性网卡的创建时间。

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

allowed_address_pairs

Array of AllowAddressPair objects

  • 扩展属性：IP/Mac对列表，allow_address_pair参见“allow_address_pair对象”表。

  • 使用说明：

    • IP地址不允许为 “0.0.0.0”。

    • 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。

    • 硬件SDN环境不支持ip_address属性配置为CIDR格式。

state

String

  • 功能说明：辅助弹性网卡当前状态。

instance_id

String

  • 功能说明：辅助弹性网卡所属实例ID，例如RDS实例ID。

instance_type

String

  • 功能说明：辅助弹性网卡所属实例类型，例如“RDS”。

scope

String

  • 功能说明：辅助弹性网卡所在站点的公网出口信息。

security_enabled

Boolean

  • 功能说明：辅助弹性网卡安全使能标记，如果不使能则安全组不生效。
表7 ResourceTag

参数

参数类型

描述

key

String

  • 功能说明：标签键。

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

最小长度：1

最大长度：128

value

String

  • 功能说明：标签值。

最大长度：255
表8 AllowAddressPair

参数

参数类型

描述

ip_address

String

  • 功能说明：

    • IP地址不支持0.0.0.0。

    • 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。

mac_address

String

  • 功能说明：MAC地址。

请求示例

创建辅助弹性网卡，虚拟子网id为08278e6c-61ca-46c1-9fc3-0d4f6c12f193，宿主网络接口id为637748df-2986-4350-8303-95d259580fb3，关联安全组6727c950-9f01-47a2-a7aa-7d3686c4c95b。

POST https://{Endpoint}/v3/8c6fb137a48a428aaf9a0229dca4edb3/vpc/sub-network-interfaces

{
  "sub_network_interface" : {
    "virsubnet_id" : "08278e6c-61ca-46c1-9fc3-0d4f6c12f193",
    "parent_id" : "637748df-2986-4350-8303-95d259580fb3",
    "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ]
  }
}

响应示例

状态码： 201

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

{
  "sub_network_interface" : {
    "id" : "2be868f2-f7c9-48db-abc0-eea0b9105b0d",
    "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3",
    "virsubnet_id" : "08278e6c-61ca-46c1-9fc3-0d4f6c12f193",
    "private_ip_address" : "10.0.0.225",
    "mac_address" : "fa:16:3e:48:f8:6f",
    "parent_device_id" : "1ab01f1d-4ef7-4d83-82be-802b3aca0223",
    "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ],
    "allowed_address_pairs" : [ ],
    "vpc_id" : "63b97e6b-3598-430f-9eb8-1caf06937be8",
    "parent_id" : "637748df-2986-4350-8303-95d259580fb3",
    "vlan_id" : 2787,
    "instance_type" : "",
    "instance_id" : "",
    "tags" : [ ],
    "created_at" : "2020-05-19T01:16:25.000+00:00"
  },
  "request_id" : "ceb6273e-1ec9-4168-ac11-3dfeaacfc889"
}

状态码

状态码

描述

201

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

错误码

请参见错误码。

父主题： 辅助弹性网卡