Querying Details of a Supplementary Network Interface
Function
This API is used to query details about a supplementary network interface.
URI
GET /v3/{project_id}/vpc/sub-network-interfaces/{sub_network_interface_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
sub_network_interface_id |
Yes |
String |
Unique identifier of the supplementary network interface. |
Request Parameters
None
Response Parameters
When the status code is 200, the response parameters are as follows:
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
sub_network_interface |
SubNetworkInterface object |
Response body of a supplementary network interface. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
|
virsubnet_id |
String |
|
private_ip_address |
String |
|
ipv6_ip_address |
String |
|
mac_address |
String |
|
parent_device_id |
String |
|
parent_id |
String |
|
description |
String |
|
vpc_id |
String |
|
vlan_id |
Integer |
|
security_enabled |
Boolean |
|
security_groups |
Array of strings |
|
tags |
Array of strings |
|
project_id |
String |
|
created_at |
String |
|
Example Request
GET https://{Endpoint}/v3/{project_id}/vpc/sub-network-interfaces/2be868f2-f7c9-48db-abc0-eea0b9105b0d
Example Response
When the status code is 200, the response parameters are as follows:
OK
{ "sub_network_interface" : { "id" : "2be868f2-f7c9-48db-abc0-eea0b9105b0d", "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3", "virsubnet_id" : "08278e6c-61ca-46c1-9fc3-0d4f6c12f193", "private_ip_address" : "10.0.0.225", "ipv6_ip_address" : null, "mac_address" : "fa:16:3e:48:f8:6f", "parent_device_id" : "1ab01f1d-4ef7-4d83-82be-802b3aca0223", "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "vpc_id" : "63b97e6b-3598-430f-9eb8-1caf06937be8", "description" : null, "parent_id" : "637748df-2986-4350-8303-95d259580fb3", "vlan_id" : 2787, "tags" : [ ], "created_at" : "2020-05-19T01:16:25Z" }, "request_id" : "ceb6273e-1ec9-4168-ac11-3dfeaacfc889" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
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