Skip to main content

private_endpoints

Creates, updates, deletes, gets or lists a private_endpoints resource.

Overview​

Nameprivate_endpoints
TypeResource
Idoci.object_storage.private_endpoints

Fields​

The following fields are returned by SELECT queries:

A private endpoint representation for the requested private endpoint.

NameDatatypeDescription
idstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the PrivateEndpoint.
namestringThis name associated with the endpoint. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods. Example: my-new-private-endpoint1
accessTargetsarrayA list of targets that can be accessed by the private endpoint. At least one or more access targets is required for a private endpoint.
additionalPrefixesarrayA list of additional prefix that you can provide along with any other prefix. These resulting endpointFqdn's are added to the customer VCN's DNS record.
compartmentIdstringThe compartment which is associated with the Private Endpoint.
createdBystringThe [OCID](/Content/General/Concepts/identifiers.htm) of the user who created the Private Endpoint.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
etagstringThe entity tag (ETag) for the Private Endpoint.
fqdnsobjectThe object representing FQDN details formed using prefix and additionalPrefixes.
freeformTagsobjectFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleStatestringThe Private Endpoint's lifecycle state. (CREATING, ACTIVE, INACTIVE, UPDATING, DELETING, DELETED, FAILED)
namespacestringThe Object Storage namespace associated with the private enpoint.
nsgIdsarrayA list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).
prefixstringA prefix to use for the private endpoint. The customer VCN's DNS records are updated with this prefix. The prefix input from the customer will be the first sub-domain in the endpointFqdn. Example: If the prefix chosen is "abc", then the endpointFqdn will be 'abc.private.objectstorage.<region>.oraclecloud.com'
privateEndpointIpstringThe private IP address to assign to this private endpoint. If you provide a value, it must be an available IP address in the customer's subnet. If it's not available, an error is returned. If you do not provide a value, an available IP address in the subnet is automatically chosen.
securityAttributesobjectSecurity attributes for Private Endpoint resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: &#123;"Oracle-ZPR": &#123;"MaxEgressCount": &#123;"value": "42", "mode": "enforce"&#125;&#125;&#125;
subnetIdstringThe OCID of the customer's subnet where the private endpoint VNIC will reside.
timeCreatedstring (date-time)The date and time the Private Endpoint was created, as described in [RFC 2616](https:​//tools.ietf.org/html/rfc2616#section-14.29).
timeModifiedstring (date-time)The date and time the Private Endpoint was updated, as described in [RFC 2616](https:​//tools.ietf.org/html/rfc2616#section-14.29).

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectnamespaceName, peName, regionif-match, if-none-match, opc-client-request-idGets the current representation of the given Private Endpoint in the given Object Storage namespace.<br />
listselectnamespaceName, compartmentId, regionlimit, page, fields, opc-client-request-id, lifecycleStateGets a list of all PrivateEndpointSummary in a compartment associated with a namespace.<br />To use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,<br />talk to an administrator. If you are an administrator who needs to write policies to give users access, see<br />[Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).<br />
createinsertnamespaceName, region, name, compartmentId, subnetId, prefix, accessTargetsopc-client-request-idCreate a PrivateEndpoint.<br />
updateupdatenamespaceName, peName, regionopc-client-request-id, if-matchPerforms a partial or full update of a user-defined data associated with the Private Endpoint.<br /><br />Use UpdatePrivateEndpoint to move a Private Endpoint from one compartment to another within the same tenancy. Supply the compartmentID<br />of the compartment that you want to move the Private Endpoint to. Or use it to update the name, subnetId, endpointFqdn or privateEndpointIp or accessTargets of the Private Endpoint.<br />For more information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br /><br />This API follows replace semantics (rather than merge semantics). That means if the body provides values for <br />parameters and the resource has exisiting ones, this operation will replace those existing values. <br />
deletedeletenamespaceName, peName, regionif-match, opc-client-request-idDeletes a Private Endpoint if it exists in the given namespace.<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.

NameDatatypeDescription
compartmentIdstringThe ID of the compartment in which to list buckets.
namespaceNamestringThe Object Storage namespace used for the request.
peNamestringThe name of the private endpoint. Avoid entering confidential information. Example: my-new-pe-1
regionstringOCI 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)
fieldsarrayPrivateEndpoint summary in list of PrivateEndpoints includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated', 'timeModified' and 'etag' fields. This parameter can also include 'tags' (freeformTags and definedTags). The only supported value of this parameter is 'tags' for now. Example 'tags'.
if-matchstringThe entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of the existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload the resource.
if-none-matchstringThe entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not match the ETag of the existing resource, the request returns the expected response. If the ETag matches the ETag of the existing resource, the request returns an HTTP 304 status without a response body.
lifecycleStatestringThe lifecycle state of the Private Endpoint
limitintegerFor 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](/iaas/Content/API/Concepts/usingapi.htm#nine).
opc-client-request-idstringThe client request ID for tracing.
pagestringFor 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](/iaas/Content/API/Concepts/usingapi.htm#nine).

SELECT examples​

Gets the current representation of the given Private Endpoint in the given Object Storage namespace.<br />

SELECT
id,
name,
accessTargets,
additionalPrefixes,
compartmentId,
createdBy,
definedTags,
etag,
fqdns,
freeformTags,
lifecycleState,
namespace,
nsgIds,
prefix,
privateEndpointIp,
securityAttributes,
subnetId,
timeCreated,
timeModified
FROM oci.object_storage.private_endpoints
WHERE namespaceName = '{{ namespaceName }}' -- required
AND peName = '{{ peName }}' -- required
AND region = '{{ region }}' -- required
AND if-match = '{{ if-match }}'
AND if-none-match = '{{ if-none-match }}'
AND opc-client-request-id = '{{ opc-client-request-id }}'
;

INSERT examples​

Create a PrivateEndpoint.<br />

INSERT INTO oci.object_storage.private_endpoints (
accessTargets,
additionalPrefixes,
compartmentId,
definedTags,
freeformTags,
name,
nsgIds,
prefix,
privateEndpointIp,
securityAttributes,
subnetId,
namespaceName,
region,
opc-client-request-id
)
SELECT 
'{{ accessTargets }}' /* required */,
'{{ additionalPrefixes }}',
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ freeformTags }}',
'{{ name }}' /* required */,
'{{ nsgIds }}',
'{{ prefix }}' /* required */,
'{{ privateEndpointIp }}',
'{{ securityAttributes }}',
'{{ subnetId }}' /* required */,
'{{ namespaceName }}',
'{{ region }}',
'{{ opc-client-request-id }}'
;

UPDATE examples​

Performs a partial or full update of a user-defined data associated with the Private Endpoint.<br /><br />Use UpdatePrivateEndpoint to move a Private Endpoint from one compartment to another within the same tenancy. Supply the compartmentID<br />of the compartment that you want to move the Private Endpoint to. Or use it to update the name, subnetId, endpointFqdn or privateEndpointIp or accessTargets of the Private Endpoint.<br />For more information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br /><br />This API follows replace semantics (rather than merge semantics). That means if the body provides values for <br />parameters and the resource has exisiting ones, this operation will replace those existing values. <br />

UPDATE oci.object_storage.private_endpoints
SET 
accessTargets = '{{ accessTargets }}',
definedTags = '{{ definedTags }}',
freeformTags = '{{ freeformTags }}',
name = '{{ name }}',
namespace = '{{ namespace }}',
securityAttributes = '{{ securityAttributes }}'
WHERE 
namespaceName = '{{ namespaceName }}' --required
AND peName = '{{ peName }}' --required
AND region = '{{ region }}' --required
AND opc-client-request-id = '{{ opc-client-request-id}}'
AND if-match = '{{ if-match}}';

DELETE examples​

Deletes a Private Endpoint if it exists in the given namespace.<br />

DELETE FROM oci.object_storage.private_endpoints
WHERE namespaceName = '{{ namespaceName }}' --required
AND peName = '{{ peName }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-client-request-id = '{{ opc-client-request-id }}'
;