Querying Supplementary Network Interfaces
Function
This API is used to query supplementary network interfaces. A maximum of 2,000 records can be returned for each query.
URI
GET /v3/{project_id}/vpc/sub-network-interfaces
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
ARRAY |
|
description |
No |
ARRAY |
|
limit |
No |
Integer |
Number of records returned on each page. |
mac_address |
No |
ARRAY |
|
marker |
No |
String |
Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. |
parent_id |
No |
ARRAY |
|
private_ip_address |
No |
ARRAY |
|
virsubnet_id |
No |
ARRAY |
|
vpc_id |
No |
ARRAY |
|
Request Parameters
None
Response Parameters
When the status code is 200, the response parameters are as follows:
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
|
sub_network_interfaces |
Array of SubNetworkInterface objects |
|
page_info |
PageInfo object |
Pagination information. |
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?vpc_id=63b97e6b-3598-430f-9eb8-1caf06937be8
Example Response
When the status code is 200, the response parameters are as follows:
OK
{ "request_id" : "e4cb9e3a-7b99-41c9-afd8-1630fe313299", "sub_network_interfaces" : [ { "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" }, { "id" : "55761e2d-8f72-42c0-9874-98e9885bf0fe", "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3", "virsubnet_id" : "08278e6c-61ca-46c1-9fc3-0d4f6c12f193", "private_ip_address" : "10.0.3.55", "ipv6_ip_address" : null, "mac_address" : "fa:16:3e:c2:2c:ba", "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" : 799, "tags" : [ ], "created_at" : "2020-05-19T01:16:31Z" } ], "page_info" : { "next_marker" : "55761e2d-8f72-42c0-9874-98e9885bf0fe", "previous_marker" : "2be868f2-f7c9-48db-abc0-eea0b9105b0d", "current_count" : 2 } }
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