ListVnicAttachments
get
/20160918/vnicAttachments
List the VNIC attachments in the specified compartment. A VNIC attachment resides in the same compartment as the attached instance. The list can be filtered by instance, VNIC, or availability domain.
Request
Supported Media Types
- application/json
Query Parameters
-
availabilityDomain: string
The availability domain of the pod shape.
-
compartmentId(required): string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment. -
instanceId: string
The OCID of the instance.
-
limit: integer
Minimum Value:
1
Maximum Value:1000
For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.Default Value:100
-
page: string
Minimum Length:
1
Maximum Length:512
For list pagination. The value of the opc-next-page response header from the previous List call.Default Value:oracle.doceng.json.BetterJsonNull@2c07545f
-
vnicId: string
The OCID of the VNIC.
Response
Supported Media Types
- application/json
- application/x-json-stream
200 Response
The list is being retrieved.
Headers
-
opc-next-page: string
For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object VnicAttachment
Represents an attachment between a VNIC and an instance. Avoid entering confidential information when you supply string values using the API.
Nested Schema : VnicAttachment
Type:
object
Represents an attachment between a VNIC and an instance. Avoid entering confidential information when you supply string values using the API.
Show Source
-
availabilityDomain(required):
string
Minimum Length:
1
Maximum Length:255
The availability domain of the instance. Example: AD-1 -
compartmentId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in. -
displayName:
string
Minimum Length:
1
Maximum Length:255
A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information. -
id(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the VNIC attachment. -
instanceId(required):
string
Minimum Length:
1
Maximum Length:255
The OCID of the instance. -
lifecycleState(required):
string
Allowed Values:
[ "ATTACHING", "ATTACHED", "DETACHING", "DETACHED" ]
The current state of the VNIC attachment. -
nicIndex:
integer(int32)
Minimum Value:
0
Maximum Value:31
Which physical network interface card (NIC) the VNIC uses. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. -
subnetId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the subnet to create the VNIC in. -
timeCreated(required):
string(date-time)
The date and time the VNIC attachment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
-
vlanId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the VLAN to create the VNIC in. Creating the VNIC in a VLAN (instead of a subnet) is possible only if you are an Oracle Cloud VMware Solution customer. An error is returned if the instance already has a VNIC attached to it from this VLAN. -
vlanTag:
integer(int32)
The Oracle-assigned VLAN tag of the attached VNIC. Available after the attachment process is complete. However, if the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution, the vlanTag value is instead the value of the vlanTag attribute for the VLAN.
-
vnicId:
string
Minimum Length:
1
Maximum Length:255
The OCID of the VNIC. Available after the attachment process is complete.
400 Response
Bad Request
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
401 Response
Unauthorized
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
404 Response
Not Found
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
500 Response
Internal Server Error
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload
Default Response
An error has occurred.
Headers
-
opc-request-id: string
Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
Root Schema : Error
Type:
object
The properties that define an error.
Show Source
-
code(required):
string
A short error code that defines the error, meant for programmatic parsing..Example:
UnknownError
-
message(required):
string
A human-readable error string.Example:
error validating payload