文档首页/ 虚拟私有云 VPC/ API参考/ API V3/ 端口/ 端口插入安全组
更新时间：2024-10-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

端口插入安全组

功能介绍

端口插入安全组。

调试

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

URI

PUT /v3/{project_id}/ports/{port_id}/insert-security-groups

表1 路径参数

参数

是否必选

参数类型

描述

port_id

是

String

端口的唯一标识。

project_id

是

String

项目ID。

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

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

port

是

InsertSecurityGroupOption object

端口插入安全组请求体。
表3 InsertSecurityGroupOption

参数

是否必选

参数类型

描述

security_groups

是

Array of strings

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

index

否

Integer

安全组插入的位置，从0开始计数。

举例：

  1. 要插入到已关联安全组列表的首位，index=0；

  2. 要插入到已关联安全组列表的第n个安全组后面，index=n。

    默认插入到端口已关联的安全组列表末尾。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

port

Port object

端口插入安全组的响应体。
表5 Port

参数

参数类型

描述

admin_state_up

Boolean

功能描述：管理状态。

取值范围：true，false。

默认值：true。

binding:host_id

String

功能描述：主机ID。

约束：管理员权限，普通租户不可见。

binding:profile

Object

功能描述：提供用户设置自定义信息。

binding:vif_details

Object

功能描述：vif的详细信息， "ovs_hybrid_plug"，表示是否为ovs/bridge混合模式。

binding:vif_type

String

功能描述：端口的接口类型 (ovs/hw_veb等)(扩展属性)。

约束：管理员权限，普通租户不可见。

binding:vnic_type

String

功能描述：绑定的vNIC类型。

取值范围：

  • normal: 软交换。

  • direct: SRIOV硬直通（不支持）。

created_at

String

功能说明：创建时间。

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

updated_at

String

功能说明：更新时间。

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

description

String

功能说明：端口描述。

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

device_id

String

功能描述：端口所属设备ID。

取值范围：标准UUID。

约束：不支持设置和更新，由系统自动维护。

device_owner

String

功能描述：设备所属（DHCP/Router/ lb/Nova）。

ecs_flavor

String

功能描述：标识这个端口所属虚拟机的flavor。

id

String

功能描述：端口唯一标识。

取值范围：标准UUID。

instance_id

String

功能描述：端口所属实例ID，例如RDS实例ID。

约束：不支持设置和更新，由系统自动维护。

instance_type

String

功能描述：端口所属实例类型，例如“RDS”。

约束：不支持设置和更新，由系统自动维护。

mac_address

String

功能描述：MAC地址。

name

String

功能描述：端口名称。

取值范围：默认为空，最大长度不超过255。

port_security_enabled

Boolean

功能描述：端口安全使能标记，如果不使能则安全组和dhcp防欺骗不生效。

取值范围：true/false。

private_ips

Array of PrivateIpInfo objects

功能描述：port的私有IP地址。

project_id

String

功能描述：项目ID。

security_groups

Array of strings

功能描述：安全组列表。

status

String

功能描述：端口状态。

取值范围：ACTIVE，BUILD，DOWN。

tenant_id

String

功能描述：租户ID。

virsubnet_id

String

功能描述：所属网络ID。

取值范围：标准UUID。

vpc_id

String

功能描述：VPC的ID。

取值范围：标准UUID。

vpc_tenant_id

String

功能描述：VPC_租户ID。

取值范围：UUID。

vtep_ip

String

功能描述：本地IP。

enable_efi

Boolean

功能描述：是否使能efi，使能则表示端口支持vRoCE能力。

取值范围：true，false。

scope

String

功能描述：作用域。

取值范围：

  • center，表示作用域为中心。

  • {azId}，表示作用域为具体的可用区。

    默认值：center。

zone_id

String

功能描述：端口所属的可用分区。

binding:migration_info

Object

功能描述：迁移目的节点信息，包括目的节点的binding:vif_details和binding:vif_type。

extra_dhcp_opts

Array of ExtraDhcpOpt objects

功能描述：DHCP的扩展属性。

position_type

String

功能描述：边缘场景位置类型。

默认值：center。

instance_info

Object

功能描述：端口绑定实例信息。

tags

Array of strings

功能描述：端口标签。

allowed_address_pairs

Array of AllowAddressPair objects

功能描述：IP/Mac对列表。

约束：

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

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

  • 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目地址检查开关。

  • 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。
表6 PrivateIpInfo

参数

参数类型

描述

subnet_cidr_id

String

端口所属子网ID。

ip_address

String

端口私有IP地址。
表7 ExtraDhcpOpt

参数

参数类型

描述

opt_name

String

Option名称。

opt_value

String

Option值。
表8 AllowAddressPair

参数

参数类型

描述

ip_address

String

  • 功能说明：

    • IP地址不支持0.0.0.0。

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

mac_address

String

  • 功能说明：MAC地址。

请求示例

指定端口插入安全组，端口99fd0c77-56b4-4bf6-8365-df352e45d5fc已关联的安全组列表为["567be4e3-d171-46ce-9e8a-c15e91cfe86a", "4940b983-5992-4663-bed9-d1d1e15d1009"]，要将新安全组插入到第1个安全组567be4e3-d171-46ce-9e8a-c15e91cfe86a后面，此时新安全组插入的index为1。

PUT https://{Endpoint}/v3/f5dab68cd75740e68c599e9af5fe0aed/ports/99fd0c77-56b4-4bf6-8365-df352e45d5fc/insert-security-groups

{
  "port" : {
    "security_groups" : [ "8edd3747-ccd4-49a1-82b9-a165eec314b4", "6c2d4540-3b7d-4207-a319-a7231b439995" ],
    "index" : 1
  }
}

响应示例

状态码： 200

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

{
  "port" : {
    "name" : "",
    "id" : "99fd0c77-56b4-4bf6-8365-df352e45d5fc",
    "admin_state_up" : true,
    "status" : "DOWN",
    "project_id" : "f5dab68cd75740e68c599e9af5fe0aed",
    "device_id" : "",
    "mac_address" : "fa:16:3e:1f:17:df",
    "device_owner" : "",
    "description" : "",
    "zone_id" : "",
    "scope" : "center",
    "position_type" : "center",
    "created_at" : "2023-05-10T01:35:02.000+00:00",
    "updated_at" : "2023-05-10T01:35:02.000+00:00",
    "port_security_enabled" : true,
    "tags" : [ ],
    "security_groups" : [ "567be4e3-d171-46ce-9e8a-c15e91cfe86a", "8edd3747-ccd4-49a1-82b9-a165eec314b4", "6c2d4540-3b7d-4207-a319-a7231b439995", "4940b983-5992-4663-bed9-d1d1e15d1009" ],
    "allowed_address_pairs" : [ ],
    "extra_dhcp_opts" : [ ],
    "instance_id" : "",
    "instance_type" : "",
    "ecs_flavor" : "",
    "enable_efi" : false,
    "virsubnet_id" : "3847b263-2370-45c0-8236-38a1de568049",
    "private_ips" : [ {
      "subnet_cidr_id" : "ffe98087-6d4f-45cd-988b-1c87f75d2d53",
      "ip_address" : "192.168.158.228"
    } ],
    "binding:host_id" : "",
    "binding:vif_type" : "unbound",
    "binding:vnic_type" : "normal",
    "binding:vif_details" : { },
    "binding:profile" : { },
    "binding:migration_info" : { }
  },
  "request_id" : "458691c0-7db2-43d8-9400-053800c5ff53"
}

状态码

状态码

描述

200

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

错误码

请参见错误码。

父主题： 端口