WAA Functions

CHANGE_WEB_APP_ACCELERATION_COMPARTMENT Function

Moves a Web App Acceleration resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_web_app_acceleration_compartment (
  web_app_acceleration_id varchar2,
  change_web_app_acceleration_compartment_details dbms_cloud_oci_waa_change_web_app_acceleration_compartment_details_t,
  if_match 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_waa_waa_change_web_app_acceleration_compartment_response_t;

Parameters

Parameter	Description
`web_app_acceleration_id`	(required) The OCID of the WebAppAcceleration.
`change_web_app_acceleration_compartment_details`	(required) The information to be updated.
`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_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

CHANGE_WEB_APP_ACCELERATION_POLICY_COMPARTMENT Function

Moves a WebAppAccelerationfPolicy resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Syntax

FUNCTION change_web_app_acceleration_policy_compartment (
  web_app_acceleration_policy_id varchar2,
  change_web_app_acceleration_policy_compartment_details dbms_cloud_oci_waa_change_web_app_acceleration_policy_compartment_details_t,
  if_match 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_waa_waa_change_web_app_acceleration_policy_compartment_response_t;

Parameters

Parameter	Description
`web_app_acceleration_policy_id`	(required) The OCID of the WebAppAccelerationPolicy.
`change_web_app_acceleration_policy_compartment_details`	(required) The information to be updated.
`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_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

CREATE_WEB_APP_ACCELERATION Function

Creates a new WebAppAcceleration.

Syntax

FUNCTION create_web_app_acceleration (
  create_web_app_acceleration_details dbms_cloud_oci_waa_create_web_app_acceleration_details_t,
  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_waa_waa_create_web_app_acceleration_response_t;

Parameters

Parameter	Description
`create_web_app_acceleration_details`	(required) Details for the new WebAppAcceleration.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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 might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

CREATE_WEB_APP_ACCELERATION_POLICY Function

Creates a new WebAppAccelerationPolicy.

Syntax

FUNCTION create_web_app_acceleration_policy (
  create_web_app_acceleration_policy_details dbms_cloud_oci_waa_create_web_app_acceleration_policy_details_t,
  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_waa_waa_create_web_app_acceleration_policy_response_t;

Parameters

Parameter	Description
`create_web_app_acceleration_policy_details`	(required) Details for the new WebAppAccelerationPolicy.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. 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 might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

DELETE_WEB_APP_ACCELERATION Function

Deletes a WebAppAcceleration resource identified by the OCID.

Syntax

FUNCTION delete_web_app_acceleration (
  web_app_acceleration_id varchar2,
  if_match 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_waa_waa_delete_web_app_acceleration_response_t;

Parameters

Parameter	Description
`web_app_acceleration_id`	(required) The OCID of the WebAppAcceleration.
`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_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

DELETE_WEB_APP_ACCELERATION_POLICY Function

Deletes a WebAppAccelerationPolicy resource identified by the OCID.

Syntax

FUNCTION delete_web_app_acceleration_policy (
  web_app_acceleration_policy_id varchar2,
  if_match 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_waa_waa_delete_web_app_acceleration_policy_response_t;

Parameters

Parameter	Description
`web_app_acceleration_policy_id`	(required) The OCID of the WebAppAccelerationPolicy.
`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_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

GET_WEB_APP_ACCELERATION Function

Gets a WebAppAcceleration by OCID.

Syntax

FUNCTION get_web_app_acceleration (
  web_app_acceleration_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_waa_waa_get_web_app_acceleration_response_t;

Parameters

Parameter	Description
`web_app_acceleration_id`	(required) The OCID of the WebAppAcceleration.
`opc_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

GET_WEB_APP_ACCELERATION_POLICY Function

Gets a WebAppAccelerationPolicy with the given OCID.

Syntax

FUNCTION get_web_app_acceleration_policy (
  web_app_acceleration_policy_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_waa_waa_get_web_app_acceleration_policy_response_t;

Parameters

Parameter	Description
`web_app_acceleration_policy_id`	(required) The OCID of the WebAppAccelerationPolicy.
`opc_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

LIST_WEB_APP_ACCELERATION_POLICIES Function

Gets a list of all WebAppAccelerationPolicies in a compartment.

Syntax

FUNCTION list_web_app_acceleration_policies (
  compartment_id varchar2,
  lifecycle_state dbms_cloud_oci_waa_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by 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_waa_waa_list_web_app_acceleration_policies_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycleState.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`id`	(optional) A filter to return only the WebAppAccelerationPolicy with the given OCID.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

LIST_WEB_APP_ACCELERATIONS Function

Gets a list of all WebAppAccelerations in a compartment.

Syntax

FUNCTION list_web_app_accelerations (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  web_app_acceleration_policy_id varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_waa_varchar2_tbl DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by 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_waa_waa_list_web_app_accelerations_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`id`	(optional) A filter to return only the WebAppAcceleration with the given OCID.
`web_app_acceleration_policy_id`	(optional) A filter to return only the WebAppAcceleration with the given OCID of related WebAppAccelerationPolicy.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycleState.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'displayName'
`opc_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

PURGE_WEB_APP_ACCELERATION_CACHE Function

Clears resources from the cache of the WebAppAcceleration. Each new request for a purged resource will be forwarded to the origin server to fetch a new version of the resource.

Syntax

FUNCTION purge_web_app_acceleration_cache (
  web_app_acceleration_id varchar2,
  purge_web_app_acceleration_cache_details dbms_cloud_oci_waa_purge_web_app_acceleration_cache_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_waa_waa_purge_web_app_acceleration_cache_response_t;

Parameters

Parameter	Description
`web_app_acceleration_id`	(required) The OCID of the WebAppAcceleration.
`purge_web_app_acceleration_cache_details`	(required) Options for the cache purge.
`opc_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

UPDATE_WEB_APP_ACCELERATION Function

Updates the WebAppAcceleration identified by the OCID.

Syntax

FUNCTION update_web_app_acceleration (
  web_app_acceleration_id varchar2,
  update_web_app_acceleration_details dbms_cloud_oci_waa_update_web_app_acceleration_details_t,
  if_match 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_waa_waa_update_web_app_acceleration_response_t;

Parameters

Parameter	Description
`web_app_acceleration_id`	(required) The OCID of the WebAppAcceleration.
`update_web_app_acceleration_details`	(required) The information to be updated.
`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_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

UPDATE_WEB_APP_ACCELERATION_POLICY Function

Update the WebAppAccelerationPolicy identified by the OCID.

Syntax

FUNCTION update_web_app_acceleration_policy (
  web_app_acceleration_policy_id varchar2,
  update_web_app_acceleration_policy_details dbms_cloud_oci_waa_update_web_app_acceleration_policy_details_t,
  if_match 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_waa_waa_update_web_app_acceleration_policy_response_t;

Parameters

Parameter	Description
`web_app_acceleration_policy_id`	(required) The OCID of the WebAppAccelerationPolicy.
`update_web_app_acceleration_policy_details`	(required) The information to be updated.
`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_request_id`	(optional) The client request ID for tracing.
`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://waa.{region}.oci.{secondLevelDomain}.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.

Oracle Cloud Infrastructure Documentation

WAA Functions

CHANGE_WEB_APP_ACCELERATION_COMPARTMENT Function

CHANGE_WEB_APP_ACCELERATION_POLICY_COMPARTMENT Function

CREATE_WEB_APP_ACCELERATION Function

CREATE_WEB_APP_ACCELERATION_POLICY Function

DELETE_WEB_APP_ACCELERATION Function

DELETE_WEB_APP_ACCELERATION_POLICY Function

GET_WEB_APP_ACCELERATION Function

GET_WEB_APP_ACCELERATION_POLICY Function

LIST_WEB_APP_ACCELERATION_POLICIES Function

LIST_WEB_APP_ACCELERATIONS Function

PURGE_WEB_APP_ACCELERATION_CACHE Function

UPDATE_WEB_APP_ACCELERATION Function

UPDATE_WEB_APP_ACCELERATION_POLICY Function