Jump to

• Request
• Response

GetVnicAttachment

get

/20160918/vnicAttachments/{vnic_attachment_id}

Get the information for the specified VNIC attachment.

Request

Supported Media Types

• application/json

Path Parameters

• vnicAttachmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the VNIC attachment.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The VNIC attachment was retrieved.

Headers

• etag: string
  For optimistic concurrency control. See if-match.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root 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.

{
    "x-obmcs-splat":{
        "resourceKind":"vnic-attachments",
        "adLocality":"ad-local",
        "activeLifecycleStates":[
            "ATTACHED"
        ],
        "deletedLifecycleStates":[
            "DETACHED"
        ],
        "getOperationId":"GetVnicAttachment",
        "listResourcesOperationId":"ListVnicAttachments",
        "ocidEntityType":"vnicattachment",
        "generateOcidVersion":"V3",
        "useSurrogateKeyForCreation":true,
        "getBySurrogateKeyUri":"/20160918/vnicAttachments/surrogateKey",
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"InstanceVnicAttachment",
            "scope":"customer",
            "rvnFromHeader":true,
            "showDeletedResources":true
        }
    },
    "description":"Represents an attachment between a VNIC and an instance. Avoid entering confidential information when you supply string values using the API.",
    "properties":{
        "availabilityDomain":{
            "description":"The availability domain of the instance. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment the VNIC attachment is in, which is the same compartment the instance is in.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Does not need to be unique, and it is changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "id":{
            "description":"The OCID of the VNIC attachment.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "instanceId":{
            "description":"The OCID of the instance.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the VNIC attachment.",
            "enum":[
                "ATTACHING",
                "ATTACHED",
                "DETACHING",
                "DETACHED"
            ],
            "type":"string"
        },
        "nicIndex":{
            "description":"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.",
            "format":"int32",
            "maximum":"31",
            "minimum":"0",
            "type":"integer"
        },
        "subnetId":{
            "description":"The OCID of the subnet to create the VNIC in.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "vlanId":{
            "description":"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.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "timeCreated":{
            "description":"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 ",
            "format":"date-time",
            "type":"string"
        },
        "vlanTag":{
            "description":"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.",
            "format":"int32",
            "type":"integer"
        },
        "vnicId":{
            "description":"The OCID of the VNIC. Available after the attachment process is complete.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        }
    },
    "required":[
        "id",
        "compartmentId",
        "instanceId",
        "lifecycleState",
        "availabilityDomain",
        "timeCreated"
    ],
    "type":"object"
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

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.

Body ()

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

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top