Get NIC Properties
The Get NIC Properties operation retrieves the properties of a single NIC object that is designated by its element ID and the object ID of the owning partition.
HTTP method and URI
GET /api/partitions/{partition-id}/nics/{nic-id}
URI variables:
Name | Type | Description |
---|---|---|
{partition-id} | String | Object ID of the Partition object. |
{nic-id} | String | Element ID of the NIC. |
Response body contents
On successful completion, the response body contains a JSON object that provides the current values of the properties for the NIC object as defined in the Data model - NIC element object. Field names and data types in the JSON object are the same as the property names and data types defined in the Data model.
Description
This operation returns the current properties for the NIC object that is specified by the request URI.
On successful execution, all of the current properties as defined by the Data model - NIC element object are provided in the response body and HTTP status code 200 (OK) is returned.
A 404 (Not Found) status code is returned if the request URI does not designate an existing NIC element of an existing partition, or if the API user does not have object-access permission to that partition.
Authorization requirements
- Object-access permission to the Partition object designated by {partition-id}.
HTTP status and reason codes
On success, HTTP status code 200 (OK) is returned and the response body is provided as described in Response body contents.
The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.
HTTP error status code | Reason code | Description |
---|---|---|
400 (Bad Request) | Various | Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes. |
404 (Not Found) | 1 | The object-id in the URI {partition-id} does not designated an existing Partition object, or the API user does not have object-access permission to it. |
5 | The request URI does not designate an existing NIC of an existing partition. |
Additional standard status and reason codes can be returned, as described in Invoking API operations.