Adding a Security Group to a Security Group List of a Port

port_id

Yes

String

Unique identifier of a port

project_id

Yes

String

Project ID

port

Yes

InsertSecurityGroupOption object

Request body for adding a security group to a security group list of a port

security_groups

Yes

Array of strings

Security group IDs, for example, "security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]

index

No

Integer

Position that a security group is added to. The value starts from 0.

Example:

1. To add a security group to the first of the associated security group list, set index to 0.

2. To add a security group after the nth security group in the associated security group list, set index to n.

By default, a security group is added to the end of the security group list associated with the port.

request_id

String

Request ID

port

port object

Response body for adding a security group to a security group list of a port

admin_state_up

Boolean

• Administrative state
• The value can be true.
• Constraints: N/A
• Default value: true
• Permissions: N/A

binding:host_id

String

• Host ID
• Value range: N/A
• This parameter is visible only to administrators.
• Default value: N/A
• Permissions: N/A

binding:profile

Object

• User-defined settings
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

binding:vif_details

Object

• VIF details. Parameter ovs_hybrid_plug specifies whether the OVS/bridge hybrid mode is used.
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

binding:vif_type

String

• Interface type of the port. The value can be ovs, hw_veb, or others. This is an extended attribute.
• Value range: N/A
• This parameter is visible only to administrators.
• Default value: N/A
• Permissions: N/A

binding:vnic_type

String

• Type of the bound vNIC. normal indicates software switching. direct indicates SR-IOV PCIe passthrough, which is not supported.
• The value can be normal or direct.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

created_at

String

• Time when a port is created
• The value is a UTC time in the format of yyyy-MM-ddTHH:mmss.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

updated_at

String

• Time when a port is updated.
• The value is a UTC time in the format of yyyy-MM-ddTHH:mmss.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

description

String

• Supplementary information about a port
• The value can contain no more than 255 characters and cannot contain angle brackets (< or >).
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

device_id

String

• ID of the device that a port belongs to.
• The value must be in standard UUID format.
• The system automatically sets this parameter.
• Default value: N/A
• Permissions: N/A

device_owner

String

• Belonged device, which can be a DHCP server, router, load balancer, or Nova.
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

ecs_flavor

String

• Flavor of the ECS that the port belongs to
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

id

String

• Unique identifier of a port
• The value must be in standard UUID format.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

instance_id

String

• ID of the instance that the port belongs to, for example, RDS instance ID.
• Value range: N/A
• The system automatically sets this parameter.
• Default value: N/A
• Permissions: N/A

instance_type

String

• Type of the instance that the port belongs to, for example, RDS.
• Value range: N/A
• The system automatically sets this parameter.
• Default value: N/A
• Permissions: N/A

mac_address

String

• MAC address
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

name

String

• Port name
• The value can contain no more than 255 characters. This parameter is left blank by default.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

port_security_enabled

Boolean

• Whether the security option is enabled for the port. If the option is not enabled, the security group and DHCP snooping do not take effect.
• The value can be true or false.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

private_ips

Array of PrivateIpInfo objects

• Private IP address of the port
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

project_id

String

• Project ID
• The value must be in standard UUID format.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

security_groups

Array of strings

• Security group
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

status

String

• Port status
• The value can be ACTIVE, BUILD, or DOWN.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

tenant_id

String

• Tenant ID
• The value must be in standard UUID format.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

virsubnet_id

String

• Network ID
• The value must be in standard UUID format.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

vpc_id

String

• VPC ID
• The value must be in standard UUID format.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

vpc_tenant_id

String

• VPC tenant ID
• The value must be in standard UUID format.
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

vtep_ip

String

• VTEP IP address
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

enable_efi

Boolean

• Whether to enable efi. If efi is enabled, the port supports vRoCE.
• The value can be true or false.
• Constraints: N/A
• Default value: false
• Permissions: N/A

scope

String

• Application scope
• The value can be center or {azId}. center indicates that the scope is the center. {azId} indicates that the scope is a specific AZ.
• Constraints: N/A
• Default value: center
• Permissions: N/A

zone_id

String

• AZ that the port belongs to
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

binding:migration_info

Object

• Destination node information, including binding:vif_details and binding:vif_type
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

extra_dhcp_opts

Array of objects

• Extended attributes of DHCP
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

position_type

String

• Location type in the edge scenario
• Value range: N/A
• Constraints: N/A
• Default value: center
• Permissions: N/A

instance_info

Object

• Information about the instance bound to the port
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

tags

Array of strings

• Port tags
• Value range: N/A
• Constraints: N/A
• Default value: N/A
• Permissions: N/A

allowed_address_pairs

Array of AllowAddressPair objects

• A set of zero or more allowed address pairs. An address pair consists of an IP address and a MAC address.
• Value range: N/A
• Constraints:

  The IP address cannot be 0.0.0.0/0.

  Configure a dedicated security group for the port if the parameter allowed_address_pairs has a large CIDR block (subnet mask less than 24).

  If the value of allowed_address_pairs is 1.1.1.1/0, the source/destination check is disabled.

  Set allowed_address_pairs of the cloud server NIC to 1.1.1.1/0.

• Default value: N/A
• Permissions: N/A

ip_address

String

Port IP address

subnet_cidr_id

String

ID of the device that a port belongs to.

ip_address

String

IP address. You cannot set it to 0.0.0.0. Configure an independent security group for the port if parameter allowed_address_pairs has a CIDR block with a netmask length less than 24.

mac_address

String

MAC address

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error