Deze pagina is nog niet beschikbaar in uw eigen taal. We werken er hard aan om meer taalversies toe te voegen. Bedankt voor uw steun.
Querying Supplementary Network Interfaces
Function
This API is used to query supplementary network interfaces. A maximum of 2,000 records are returned for each query.
URI
GET /v3/{project_id}/vpc/sub-network-interfaces
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
|
marker |
No |
String |
Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. |
id |
No |
Array of strings |
|
description |
No |
Array of strings |
|
vpc_id |
No |
Array of strings |
|
virsubnet_id |
No |
Array of strings |
|
parent_id |
No |
Array of strings |
|
private_ip_address |
No |
Array of strings |
|
mac_address |
No |
Array of strings |
|
enable_ip |
No |
Boolean |
|
scope |
No |
String |
|
security_groups |
No |
String |
|
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
|
sub_network_interfaces |
Array of SubNetworkInterface objects |
Supplementary network interfaces. |
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_groups |
Array of strings |
|
tags |
Array of ResourceTag objects |
|
project_id |
String |
|
created_at |
String |
|
allowed_address_pairs |
Array of AllowAddressPair objects |
|
state |
String |
|
instance_id |
String |
|
instance_type |
String |
|
scope |
String |
|
security_enabled |
Boolean |
|
Parameter |
Type |
Description |
---|---|---|
key |
String |
Minimum: 1 Maximum: 128 |
value |
String |
Maximum: 255 |
Example Requests
-
Querying supplementary network interfaces by its ID.
GET https://{Endpoint}/v3/8c6fb137a48a428aaf9a0229dca4edb3/vpc/sub-network-interfaces?id=022b5c53-20e1-4f4b-b90c-0575a5e97412&id=056d6cb4-b436-460d-9a63-67666bf3ea9c
-
Querying supplementary network interfaces by combined filters.
https://{Endpoint}/v3/8c6fb137a48a428aaf9a0229dca4edb3/vpc/sub-network-interfaces?virsubnet_id=3eae2c96-de45-4c41-bf2d-e4ad53a2acb4&private_ip_address=192.168.22.177&parent_id=5eb9dc59-8159-4197-88ea-f3507ad8e0a7
-
Querying supplementary network interfaces by page.
GET https://{Endpoint}/v3/8c6fb137a48a428aaf9a0229dca4edb3/vpc/sub-network-interfaces?limit=2
Example Responses
Status code: 200
Normal response to the GET operation. For more status codes, see Status Codes.
{ "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", "mac_address" : "fa:16:3e:48:f8:6f", "parent_device_id" : "1ab01f1d-4ef7-4d83-82be-802b3aca0223", "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "allowed_address_pairs" : [ ], "vpc_id" : "63b97e6b-3598-430f-9eb8-1caf06937be8", "parent_id" : "637748df-2986-4350-8303-95d259580fb3", "vlan_id" : 2787, "instance_type" : "", "instance_id" : "", "tags" : [ ], "created_at" : "2020-05-19T01:16:25.000+00:00" }, { "id" : "55761e2d-8f72-42c0-9874-98e9885bf0fe", "project_id" : "8c6fb137a48a428aaf9a0229dca4edb3", "virsubnet_id" : "08278e6c-61ca-46c1-9fc3-0d4f6c12f193", "private_ip_address" : "10.0.3.55", "mac_address" : "fa:16:3e:c2:2c:ba", "parent_device_id" : "1ab01f1d-4ef7-4d83-82be-802b3aca0223", "security_groups" : [ "6727c950-9f01-47a2-a7aa-7d3686c4c95b" ], "allowed_address_pairs" : [ ], "vpc_id" : "63b97e6b-3598-430f-9eb8-1caf06937be8", "parent_id" : "637748df-2986-4350-8303-95d259580fb3", "vlan_id" : 799, "instance_type" : "", "instance_id" : "", "tags" : [ ], "created_at" : "2020-05-19T01:16:31.000+00:00" } ], "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 |
Normal response to the GET 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.