reachable_ips
Creates, updates, deletes, gets or lists a reachable_ips resource.
Overview​
| Name | reachable_ips |
| Type | Resource |
| Id | oci.resource_manager.reachable_ips |
Fields​
The following fields are returned by SELECT queries:
- get
Successfully retrieved the IP address.
| Name | Datatype | Description |
|---|---|---|
ipAddress | string | Reachable IP address associated with the private endpoint. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | privateIp, privateEndpointId, region | opc-request-id, opc-retry-token | Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint.<br />Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint.<br />For more information, see<br />[Getting the Reachable IP Address for a Private Endpoint](/iaas/Content/ResourceManager/Tasks/get-private-endpoint-reachable-ip.htm).<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
privateEndpointId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint. |
privateIp | string | The IP address of the resource in the private subnet. |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
opc-request-id | string | Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
opc-retry-token | string | A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of retrying the same action. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected. |
SELECT examples​
- get
Gets the reachable, or alternative, IP address for a nonpublic IP address that is associated with the private endpoint.<br />Resource Manager uses this IP address to connect to nonpublic resources through the associated private endpoint.<br />For more information, see<br />[Getting the Reachable IP Address for a Private Endpoint](/iaas/Content/ResourceManager/Tasks/get-private-endpoint-reachable-ip.htm).<br />
SELECT
ipAddress
FROM oci.resource_manager.reachable_ips
WHERE privateIp = '{{ privateIp }}' -- required
AND privateEndpointId = '{{ privateEndpointId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND opc-retry-token = '{{ opc-retry-token }}'
;