Updating a Supplementary Network Interface
Function
This API is used to update the basic information about a supplementary network interface, such as the associated security group and description.
Calling Method
For details, see Calling APIs.
URI
PUT /v3/{project_id}/vpc/sub-network-interfaces/{sub_network_interface_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: ID of the project that a supplementary network interface belongs to. For details about how to obtain a project ID, see Obtaining a Project ID. Range: N/A |
sub_network_interface_id |
Yes |
String |
Definition: ID of a supplementary network interface. Range: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
dry_run |
No |
Boolean |
Definition: Whether to only check the request. Constraints: N/A Range:
Default Value: false |
sub_network_interface |
Yes |
Definition: Request body for updating a supplementary network interface. Constraints: N/A Range: N/A Default Value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
description |
No |
String |
Definition: Description of a supplementary network interface. Constraints: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). Range: N/A Default Value: N/A |
security_groups |
No |
Array of strings |
Definition: IDs of the security groups that a supplementary network interface is associated with. For example, "security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]. Constraints: N/A Range: N/A Default Value: N/A |
allowed_address_pairs |
No |
Array of AllowedAddressPair objects |
Definition: IP/MAC address pair list of a supplementary network interface. For details, see the AllowedAddressPair object list. Constraints:
Range: N/A Default Value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ip_address |
No |
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 |
No |
String |
Definition: MAC address. 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 |
sub_network_interface |
SubNetworkInterface object |
Definition: Response body for updating a supplementary network interface. Range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: ID of a supplementary network interface. After a supplementary network interface is created, a supplementary network interface ID is generated, which uniquely identifies the supplementary network interface. Range: The value is in UUID format with hyphens (-). |
virsubnet_id |
String |
Definition: ID of the virtual subnet that a supplementary network interface is located. Range: The value is in UUID format with hyphens (-). |
private_ip_address |
String |
Definition: Private IPv4 address of a supplementary network interface. Range: N/A |
ipv6_ip_address |
String |
Definition: Private IPv6 address of a supplementary network interface. Range: N/A |
mac_address |
String |
Definition: MAC address of a supplementary network interface. Range: The value is a valid MAC address assigned by the system randomly. |
parent_device_id |
String |
Definition: Device ID of the host network interface that a supplementary network interface is attached to. Range: The value is in UUID format with hyphens (-). |
parent_id |
String |
Definition: ID of the elastic network interface that a supplementary network interface is attached to. Range: The value is in UUID format with hyphens (-). |
description |
String |
Definition: Description of a supplementary network interface. Range: The value can contain 0 to 255 characters and cannot contain angle brackets (< or >). |
vpc_id |
String |
Definition: ID of the VPC that a supplementary network interface belongs to. Range: The value is in UUID format with hyphens (-). |
vlan_id |
Integer |
Definition: VLAN ID of a supplementary network interface. Range: 1 to 4094 |
security_groups |
Array of strings |
Definition: IDs of the security groups that a supplementary network interface is associated with. For example, "security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"]. Range: If this parameter is not specified in the request, the supplementary network interface is automatically associated with the default security group after being created. |
tags |
Array of ResponseTag objects |
Definition: Tags of a supplementary network interface, including tag keys and tag values, which can be used to classify and identify resources. For details, see the tag objects. Range: N/A |
project_id |
String |
Definition: ID of the project that a supplementary network interface belongs to. Range: N/A |
created_at |
String |
Definition: Time when a supplementary network interface was created. Range: The value is a UTC time in the format of yyyy-MM-ddTHH:mm:ssZ. |
allowed_address_pairs |
Array of AllowedAddressPair objects |
Definition: IP/MAC address pair list of a supplementary network interface. For details, see the AllowedAddressPair object list. Range: N/A |
state |
String |
Definition: Status of a supplementary network interface. Range:
|
instance_id |
String |
Definition: ID of the cloud service instance that a supplementary network interface is attached to, for example, RDS instance ID. Range: N/A |
instance_type |
String |
Definition: Type of the cloud service instance that a supplementary network interface is attached to, for example, RDS. Range: N/A |
scope |
String |
Definition: Public network egress information of the site where a supplementary network interface works. Range:
|
security_enabled |
Boolean |
Definition: Whether the security option is enabled for a supplementary network interface. If the option is not enabled, the security group does not take effect. 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
Change the security group that is associated with the supplementary network interface whose ID is 2be868f2-f7c9-48db-abc0-eea0b9105b0d.
PUT https://{Endpoint}/v3/8c6fb137a48a428aaf9a0229dca4edb3/vpc/sub-network-interfaces/2be868f2-f7c9-48db-abc0-eea0b9105b0d { "sub_network_interface" : { "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "allowed_address_pairs" : [ { "ip_address" : "1.1.1.1/0" } ] } }
Example Responses
Status code: 200
Normal response to the PUT operation. For more status codes, see Status Codes.
{ "sub_network_interface" : { "id" : "2be868f2-f7c9-48db-abc0-eea0b9105b0d", "project_id" : "6b32266bded64091a138e9ec19cff361", "virsubnet_id" : "3c15c3b0-0df4-4115-9c18-e67a8a0d7702", "private_ip_address" : "192.168.0.160", "ipv6_ip_address" : null, "mac_address" : "fa:16:3e:26:7e:1e", "parent_device_id" : "285b2e45-2968-4f4c-8992-54e0d4c8da1d", "security_enabled" : false, "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "allowed_address_pairs" : [ { "ip_address" : "1.1.1.1/0", "mac_address" : "fa:16:3e:26:7e:1e" } ], "vpc_id" : "c10e1e02-9db2-4bd0-89ef-52536952627e", "instance_id" : "", "instance_type" : "", "description" : "aaa", "parent_id" : "00336617-4552-48c5-9856-f539f4e9aca2", "vlan_id" : 3413, "state" : null, "tags" : [ ], "scope" : "center", "created_at" : "2025-02-10T08:21:16Z" }, "request_id" : "d346a69661d82c7b14bdc7ac0cd62cbd" }
SDK Sample Code
The SDK sample code is as follows.
Change the security group that is associated with the supplementary network interface whose ID is 2be868f2-f7c9-48db-abc0-eea0b9105b0d.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.vpc.v3.region.VpcRegion; import com.huaweicloud.sdk.vpc.v3.*; import com.huaweicloud.sdk.vpc.v3.model.*; import java.util.List; import java.util.ArrayList; public class UpdateSubNetworkInterfaceSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); VpcClient client = VpcClient.newBuilder() .withCredential(auth) .withRegion(VpcRegion.valueOf("<YOUR REGION>")) .build(); UpdateSubNetworkInterfaceRequest request = new UpdateSubNetworkInterfaceRequest(); request.withSubNetworkInterfaceId("{sub_network_interface_id}"); UpdateSubNetworkInterfaceRequestBody body = new UpdateSubNetworkInterfaceRequestBody(); List<AllowedAddressPair> listSubNetworkInterfaceAllowedAddressPairs = new ArrayList<>(); listSubNetworkInterfaceAllowedAddressPairs.add( new AllowedAddressPair() .withIpAddress("1.1.1.1/0") ); List<String> listSubNetworkInterfaceSecurityGroups = new ArrayList<>(); listSubNetworkInterfaceSecurityGroups.add("6727c950-9f01-47a2-a7aa-7d3686c4c95b"); UpdateSubNetworkInterfaceOption subNetworkInterfacebody = new UpdateSubNetworkInterfaceOption(); subNetworkInterfacebody.withSecurityGroups(listSubNetworkInterfaceSecurityGroups) .withAllowedAddressPairs(listSubNetworkInterfaceAllowedAddressPairs); body.withSubNetworkInterface(subNetworkInterfacebody); request.withBody(body); try { UpdateSubNetworkInterfaceResponse response = client.updateSubNetworkInterface(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Change the security group that is associated with the supplementary network interface whose ID is 2be868f2-f7c9-48db-abc0-eea0b9105b0d.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkvpc.v3.region.vpc_region import VpcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkvpc.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = VpcClient.new_builder() \ .with_credentials(credentials) \ .with_region(VpcRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateSubNetworkInterfaceRequest() request.sub_network_interface_id = "{sub_network_interface_id}" listAllowedAddressPairsSubNetworkInterface = [ AllowedAddressPair( ip_address="1.1.1.1/0" ) ] listSecurityGroupsSubNetworkInterface = [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ] subNetworkInterfacebody = UpdateSubNetworkInterfaceOption( security_groups=listSecurityGroupsSubNetworkInterface, allowed_address_pairs=listAllowedAddressPairsSubNetworkInterface ) request.body = UpdateSubNetworkInterfaceRequestBody( sub_network_interface=subNetworkInterfacebody ) response = client.update_sub_network_interface(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Change the security group that is associated with the supplementary network interface whose ID is 2be868f2-f7c9-48db-abc0-eea0b9105b0d.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" vpc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/vpc/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := vpc.NewVpcClient( vpc.VpcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateSubNetworkInterfaceRequest{} request.SubNetworkInterfaceId = "{sub_network_interface_id}" ipAddressAllowedAddressPairs:= "1.1.1.1/0" var listAllowedAddressPairsSubNetworkInterface = []model.AllowedAddressPair{ { IpAddress: &ipAddressAllowedAddressPairs, }, } var listSecurityGroupsSubNetworkInterface = []string{ "6727c950-9f01-47a2-a7aa-7d3686c4c95b", } subNetworkInterfacebody := &model.UpdateSubNetworkInterfaceOption{ SecurityGroups: &listSecurityGroupsSubNetworkInterface, AllowedAddressPairs: &listAllowedAddressPairsSubNetworkInterface, } request.Body = &model.UpdateSubNetworkInterfaceRequestBody{ SubNetworkInterface: subNetworkInterfacebody, } response, err := client.UpdateSubNetworkInterface(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
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.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot