端口插入安全组
功能介绍
端口插入安全组
URI
PUT /v3/{project_id}/ports/{port_id}/insert-security-groups
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
port_id |
是 |
String |
端口的唯一标识 |
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
port |
是 |
InsertSecurityGroupOption object |
端口插入安全组请求体 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求ID |
port |
Port object |
端口插入安全组的响应体 |
参数 |
参数类型 |
描述 |
---|---|---|
admin_state_up |
Boolean |
1、功能描述:管理状态 2、取值范围:true/false 3、约束:N/A 4、默认值:true 5、权限:N/A |
binding:host_id |
String |
1、功能描述:主机ID 2、取值范围:N/A 3、约束:管理员权限,普通租户不可见 4、默认值:N/A 5、权限:N/A |
binding:profile |
Object |
1、功能描述:提供用户设置自定义信息 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
binding:vif_details |
Object |
1、功能描述:vif的详细信息, "ovs_hybrid_plug": 是否为ovs/bridge混合模式 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
binding:vif_type |
String |
1、功能描述:端口的接口类型 (ovs/hw_veb等)(扩展属性) 2、取值范围:N/A 3、约束:管理员权限,普通租户不可见 4、默认值:N/A 5、权限:N/A |
binding:vnic_type |
String |
1、功能描述:绑定的vNIC类型normal: 软交换direct: SRIOV硬直通(不支持) 2、取值范围:normal或者direct 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
created_at |
String |
1、功能说明:创建时间 2、取值范围:格式 "UTC时间 格式: yyyy-MM-ddTHH:mm:ss" 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
updated_at |
String |
1、功能说明:创建时间 2、取值范围:格式 "UTC时间 格式: yyyy-MM-ddTHH:mm:ss" 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
description |
String |
1、功能说明:端口描述 2、取值范围:0-255个字符,不能包含“<”和“>” 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
device_id |
String |
1、功能描述:端口所属设备ID 2、取值范围:标准UUID 3、约束:不支持设置和更新,由系统自动维护 4、默认值:N/A 5、权限:N/A |
device_owner |
String |
1、功能描述:设备所属(DHCP/Router/ lb/Nova) 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
ecs_flavor |
String |
1、功能描述:标识这个端口所属虚拟机的flavor 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
id |
String |
1、功能描述:端口唯一标识 2、取值范围:标准UUID 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
instance_id |
String |
1、功能描述:端口所属实例ID,例如RDS实例ID 2、取值范围:N/A 3、约束:不支持设置和更新,由系统自动维护 4、默认值:N/A 5、权限:N/A |
instance_type |
String |
1、功能描述:端口所属实例类型,例如“RDS” 2、取值范围:N/A 3、约束:不支持设置和更新,由系统自动维护 4、默认值:N/A 5、权限:N/A |
mac_address |
String |
1、功能描述:MAC地址 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
name |
String |
1、功能描述:端口名称 2、取值范围:默认为空,最大长度不超过255 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
port_security_enabled |
Boolean |
1、功能描述:端口安全使能标记,如果不使能则安全组和dhcp防欺骗不生效 2、取值范围:true/false 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
private_ips |
Array of PrivateIpInfo objects |
1、功能描述:port的私有IP地址 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
project_id |
String |
1、功能描述:项目ID 2、取值范围:UUID 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
security_groups |
Array of strings |
1、功能描述:安全组 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
status |
String |
1、功能描述:端口状态 2、取值范围:ACTIVE,BUILD,DOWN 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
tenant_id |
String |
1、功能描述:租户ID 2、取值范围:UUID 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
virsubnet_id |
String |
1、功能描述:所属网络ID 2、取值范围:标准UUID 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
vpc_id |
String |
1、功能描述:VPC的ID 2、取值范围:标准UUID 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
vpc_tenant_id |
String |
1、功能描述:VPC_租户ID 2、取值范围:UUID 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
vtep_ip |
String |
1、功能描述:本地IP 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
enable_efi |
Boolean |
1、功能描述:是否使能efi,使能则表示端口支持vRoCE能力 2、取值范围:true or false 3、约束:N/A 4、默认值:false 5、权限:N/A |
scope |
String |
1、功能描述:作用域 2、取值范围:center,表示作用域为中心;{azId},表示作用域为具体的可用区 3、约束:N/A 4、默认值:center 5、权限:N/A |
zone_id |
String |
1、功能描述:端口所属的可用分区 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
binding:migration_info |
Object |
1、功能描述:迁移目的节点信息,包括目的节点的binding:vif_details和binding:vif_type 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
extra_dhcp_opts |
Array of objects |
1、功能描述:DHCP的扩展属性 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
position_type |
String |
1、功能描述:边缘场景位置类型 2、取值范围:N/A 3、约束:N/A 4、默认值:center 5、权限:N/A |
instance_info |
Object |
1、功能描述:端口绑定实例信息 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
tags |
Array of strings |
1、功能描述:端口标签 2、取值范围:N/A 3、约束:N/A 4、默认值:N/A 5、权限:N/A |
allowed_address_pairs |
Array of AllowAddressPair objects |
1、功能描述:IP/Mac对列表 2、取值范围:N/A 3、约束:
|
请求示例
指定端口插入安全组,端口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
OK
{ "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 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
409 |
Conflict |
500 |
Internal Server Error |
错误码
请参见错误码。