ListPrivateIps
GET {{baseUrl}}/privateIps?limit=801&ipAddress=officia sed&subnetId=amet ut&vnicId=officia sed&vlanId=amet ut
Lists the PrivateIp objects based on one of these filters:
- Subnet OCID.
- VNIC OCID.
- Both private IP address and subnet OCID: This lets
you get a
privateIP
object based on its private IP address (for example, 10.0.3.3) and not its OCID. For comparison, GetPrivateIp requires the OCID.
If you're listing all the private IPs associated with a given subnet or VNIC, the response includes both primary and secondary private IPs.
If you are an Oracle Cloud VMware Solution customer and have VLANs in your VCN, you can filter the list by VLAN OCID. See Vlan.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | number | For list pagination. The maximum number of results per page, or items to return in a paginated | |
"List" call. For important details about how pagination works, see | |||
List Pagination. |
Example: 50
|
| page
| string | | For list pagination. The value of the opc-next-page
response header from the previous "List"
call. For important details about how pagination works, see
List Pagination.
|
| ipAddress
| string | | An IP address. This could be either IPv4 or IPv6, depending on the resource.
Example: 10.0.3.3
|
| subnetId
| string | | The OCID of the subnet. |
| vnicId
| string | | The OCID of the VNIC. |
| vlanId
| string | | The OCID of the VLAN. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
[{"availabilityDomain":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"hostnameLabel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ipAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isPrimary":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"subnetId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vlanId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vnicId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"availabilityDomain":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"compartmentId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"definedTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"displayName":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"freeformTags":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"hostnameLabel":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ipAddress":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isPrimary":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lifecycleState":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"subnetId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"timeCreated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vlanId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"vnicId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}]