Removing a Security Group from the Security Group List of a Port
Function
This API is used to remove security groups from the security group list associated with the elastic network interface.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/ports/{port_id}/remove-security-groups
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
port_id |
Yes |
String |
Definition: Port ID, which can be the ID of an elastic network interface. Range: N/A |
|
project_id |
Yes |
String |
Definition: Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Range: N/A |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
port |
Yes |
RemoveSecurityGroupOption object |
Definition: Request body for removing a security group from a security group list of a port. Constraints: N/A Range: N/A Default Value: N/A |
|
dry_run |
No |
Boolean |
Definition: Whether to only check the request. Constraints: N/A Range:
Default Value: false |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
security_groups |
Yes |
Array of strings |
Definition: IDs of security groups to be removed, for example, "security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]. You can call the API Querying Security Groups to obtain the ID of the target security group, and then use this API to remove the security groups from the security group list associated with the elastic network interface. Constraints: N/A Range: N/A Default Value: N/A |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
request_id |
String |
Definition: Request ID. Range: N/A |
|
port |
Port object |
Definition: Response body for removing a security group from a security group list of a port Range: N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
admin_state_up |
Boolean |
Definition: Administrative state of this port. Range: The value can be true (default) or false |
|
binding:host_id |
String |
Definition: ID of the host where the port is located. Range: N/A |
|
binding:profile |
Object |
Definition: User-defined information of the port. Range: N/A |
|
binding:vif_details |
binding:vif_details object |
Definition: Detailed information about the VIF. Range: N/A |
|
binding:vif_type |
String |
Definition: Interface type of the port. The value can be ovs, hw_veb, or others. This is an extended attribute. Range: N/A |
|
binding:vnic_type |
String |
Definition: Type of the bound vNIC. Range:
|
|
created_at |
String |
Definition: Time when the port was created. Range: The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss. |
|
updated_at |
String |
Definition: Time when the port was last updated. Range: The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ss. |
|
description |
String |
Definition: Port description. Range: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). |
|
device_id |
String |
Definition: ID of the device that the port belongs to. Range: The value is in UUID format with hyphens (-). |
|
device_owner |
String |
Definition: Name of the device that the port belongs to. Range:
|
|
ecs_flavor |
String |
Definition: Flavor of the ECS that the port belongs to. Range: N/A |
|
id |
String |
Definition: Port ID. Range: The value is in UUID format with hyphens (-). |
|
instance_id |
String |
Definition: ID of the instance that the port belongs to, for example, RDS instance ID. Range: N/A |
|
instance_type |
String |
Definition: The type of instance that the port belongs to, for example, RDS. Range: N/A |
|
mac_address |
String |
Definition: MAC address of the port. Range: N/A |
|
name |
String |
Definition: Port name. Range: The value can contain no more than 255 characters. This parameter is left blank by default. |
|
port_security_enabled |
Boolean |
Definition: Whether the security option is enabled for a port. If the option is not enabled, the security group and DHCP snooping do not take effect. Range:
|
|
private_ips |
Array of PrivateIpInfo objects |
Definition: Private IP address of a port. Range: N/A |
|
project_id |
String |
Definition: ID of the project that the port belongs to. Range: N/A |
|
security_groups |
Array of strings |
Definition: Security groups bound to a port. Range: N/A |
|
status |
String |
Definition: Port status. Range:
|
|
tenant_id |
String |
Definition: ID of the tenant that the port belongs to. Range: N/A |
|
virsubnet_id |
String |
Definition: ID of the virtual subnet that the port belongs to. Range: The value is in UUID format with hyphens (-). |
|
vpc_id |
String |
Definition: ID of the VPC that the port belongs to. Range: The value is in UUID format with hyphens (-). |
|
vpc_tenant_id |
String |
Definition: Tenant ID of the VPC that the port belongs to. Range: N/A |
|
vtep_ip |
String |
Definition: VTEP IP address of the port, that is, the IP address of the virtual tunnel endpoint. Range: N/A |
|
enable_efi |
Boolean |
Definition: Whether to enable efi. If efi is enabled, the port supports vRoCE. Range:
|
|
scope |
String |
Definition: Scope of the subnet where the port is located (edge cloud scenario). Range:
|
|
zone_id |
String |
Definition: ID of the AZ that the port belongs to. Range: N/A |
|
binding:migration_info |
Object |
Definition: Information about the destination node where the port is migrated, including binding:vif_details and binding:vif_type of the destination node. Range: N/A |
|
extra_dhcp_opts |
Array of ExtraDhcpOpt objects |
Definition: Extended DHCP attributes. Range: N/A |
|
position_type |
String |
Definition: Location type of the port in the edge scenario. Range: Default Value: center |
|
instance_info |
Object |
Definition: Information about the instance with the port bound. Range: N/A |
|
tags |
Array of ResponseTag objects |
Definition: Tags of a port, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects. Range: N/A |
|
allowed_address_pairs |
Array of AllowedAddressPair objects |
Definition: IP address and MAC address pairs of the port. Range:
|
|
Parameter |
Type |
Description |
|---|---|---|
|
primary_interface |
Boolean |
Definition: Whether this is the primary network interface of the cloud server. Range:
|
|
port_filter |
Boolean |
Definition: Whether the network service provides port filtering features, such as security groups and anti-MAC/IP spoofing. Range:
|
|
ovs_hybrid_plug |
Boolean |
Definition: Whether the OVS/bridge hybrid mode is used. Range:
|
|
Parameter |
Type |
Description |
|---|---|---|
|
subnet_cidr_id |
String |
Definition: ID of the subnet where a port works. Range: N/A |
|
ip_address |
String |
Definition: Private IP address of a port. Range: N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
opt_name |
String |
Definition: DHCP attribute name. Name of additional control information or network configuration parameter transmitted when the DHCP server allocates IP addresses to clients. Range: N/A |
|
opt_value |
String |
Definition: DHCP attribute value. Value of additional control information or network configuration parameter transmitted when the DHCP server allocates IP addresses to clients. Range: N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
String |
Definition: Tag key. Range:
|
|
value |
String |
Definition: Tag value. Range:
|
|
Parameter |
Type |
Description |
|---|---|---|
|
ip_address |
String |
Definition: IP address. Constraints: Configure a dedicated security group if a large CIDR block (subnet mask less than 24) is configured for parameter allowed_address_pairs. Range: Single IP address, for example, 192.168.21.25 A CIDR block, for example, 192.168.21.0/24 Default Value: N/A |
|
mac_address |
String |
Definition: MAC address. Constraints: N/A Range: N/A Default Value: N/A |
Example Requests
Remove security groups (8edd3747-ccd4-49a1-82b9-a165eec314b4 and 6c2d4540-3b7d-4207-a319-a7231b439995) associated with the port (99fd0c77-56b4-4bf6-8365-df352e45d5fc).
PUT https://{Endpoint}/v3/f5dab68cd75740e68c599e9af5fe0aed/ports/99fd0c77-56b4-4bf6-8365-df352e45d5fc/remove-security-groups
{
"port" : {
"security_groups" : [ "8edd3747-ccd4-49a1-82b9-a165eec314b4", "6c2d4540-3b7d-4207-a319-a7231b439995" ]
}
}
Example Responses
Status code: 200
Normal response to the PUT operation. For more status codes, see Status Codes.
{
"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", "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" : "abd08c76-c853-4967-a898-12804330efab"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Normal response to the PUT operation. For more status codes, see Status Codes. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.