Oracle Cloud Infrastructure Documentation

OSP Gateway Address Service Functions

Package: DBMS_CLOUD_OCI_OG_ADDRESS_SERVICE

GET_ADDRESS Function

Get the address by id for the compartment

Syntax

FUNCTION get_address (
  osp_home_region varchar2,
  compartment_id varchar2,
  address_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_og_address_service_get_address_response_t;

Parameters

Parameter Description

osp_home_region

(required) The home region's public name of the logged in user.

compartment_id

(required) The OCID of the compartment.

address_id

(required) The identifier of the address.

opc_request_id

(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://ospap.oracle.com.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

VERIFY_ADDRESS Function

Verify address

Syntax

FUNCTION verify_address (
  osp_home_region varchar2,
  compartment_id varchar2,
  verify_address_details dbms_cloud_oci_osp_gateway_verify_address_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_og_address_service_verify_address_response_t;

Parameters

Parameter Description

osp_home_region

(required) The home region's public name of the logged in user.

compartment_id

(required) The OCID of the compartment.

verify_address_details

(required) Address request.

if_match

(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

opc_retry_token

(optional) For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.

opc_request_id

(optional) The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://ospap.oracle.com.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.