Application Performance Monitoring Synthetics Functions

Package: DBMS_CLOUD_OCI_ASY_APM_SYNTHETIC

AGGREGATE_NETWORK_DATA Function

Gets aggregated network data for given executions.

Syntax

FUNCTION aggregate_network_data (
  apm_domain_id varchar2,
  monitor_id varchar2,
  aggregate_network_data_details dbms_cloud_oci_apm_synthetics_aggregate_network_data_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_asy_apm_synthetic_aggregate_network_data_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`monitor_id`	(required) The OCID of the monitor.
`aggregate_network_data_details`	(required) Details of the vantage point and corresponding execution times.
`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) Unique 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://apm-synthetic.{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_DEDICATED_VANTAGE_POINT Function

Registers a new dedicated vantage point.

Syntax

FUNCTION create_dedicated_vantage_point (
  apm_domain_id varchar2,
  create_dedicated_vantage_point_details dbms_cloud_oci_apm_synthetics_create_dedicated_vantage_point_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_asy_apm_synthetic_create_dedicated_vantage_point_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`create_dedicated_vantage_point_details`	(required) The configuration details for registering a dedicated vantage point.
`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) Unique 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://apm-synthetic.{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_MONITOR Function

Creates a new monitor.

Syntax

FUNCTION create_monitor (
  apm_domain_id varchar2,
  create_monitor_details dbms_cloud_oci_apm_synthetics_create_monitor_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_asy_apm_synthetic_create_monitor_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`create_monitor_details`	(required) The configuration details for creating a monitor.
`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) Unique 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://apm-synthetic.{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_SCRIPT Function

Creates a new script.

Syntax

FUNCTION create_script (
  apm_domain_id varchar2,
  create_script_details dbms_cloud_oci_apm_synthetics_create_script_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_asy_apm_synthetic_create_script_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`create_script_details`	(required) The configuration details for creating a script.
`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) Unique 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://apm-synthetic.{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_DEDICATED_VANTAGE_POINT Function

Deregisters the specified dedicated vantage point.

Syntax

FUNCTION delete_dedicated_vantage_point (
  apm_domain_id varchar2,
  dedicated_vantage_point_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_asy_apm_synthetic_delete_dedicated_vantage_point_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`dedicated_vantage_point_id`	(required) The OCID of the dedicated vantage point.
`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) Unique 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://apm-synthetic.{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_MONITOR Function

Deletes the specified monitor.

Syntax

FUNCTION delete_monitor (
  apm_domain_id varchar2,
  monitor_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_asy_apm_synthetic_delete_monitor_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`monitor_id`	(required) The OCID of the monitor.
`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) Unique 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://apm-synthetic.{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_SCRIPT Function

Deletes the specified script.

Syntax

FUNCTION delete_script (
  apm_domain_id varchar2,
  script_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_asy_apm_synthetic_delete_script_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`script_id`	(required) The OCID of the script.
`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) Unique 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://apm-synthetic.{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_DEDICATED_VANTAGE_POINT Function

Gets the details of the dedicated vantage point identified by the OCID.

Syntax

FUNCTION get_dedicated_vantage_point (
  apm_domain_id varchar2,
  dedicated_vantage_point_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_asy_apm_synthetic_get_dedicated_vantage_point_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`dedicated_vantage_point_id`	(required) The OCID of the dedicated vantage point.
`opc_request_id`	(optional) Unique 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://apm-synthetic.{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_MONITOR Function

Gets the configuration of the monitor identified by the OCID.

Syntax

FUNCTION get_monitor (
  apm_domain_id varchar2,
  monitor_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_asy_apm_synthetic_get_monitor_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`monitor_id`	(required) The OCID of the monitor.
`opc_request_id`	(optional) Unique 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://apm-synthetic.{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_MONITOR_RESULT Function

Gets the results for a specific execution of a monitor identified by OCID. The results are in a HAR file, Screenshot, Console Log or Network details.

Syntax

FUNCTION get_monitor_result (
  apm_domain_id varchar2,
  monitor_id varchar2,
  vantage_point varchar2,
  result_type varchar2,
  result_content_type varchar2,
  execution_time varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asy_apm_synthetic_get_monitor_result_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`monitor_id`	(required) The OCID of the monitor.
`vantage_point`	(required) The vantagePoint name.
`result_type`	(required) The result type: har, screenshot, log, or network.
`result_content_type`	(required) The result content type: zip or raw.
`execution_time`	(required) The time the object was posted.
`opc_request_id`	(optional) Unique 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://apm-synthetic.{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_SCRIPT Function

Gets the configuration of the script identified by the OCID.

Syntax

FUNCTION get_script (
  apm_domain_id varchar2,
  script_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_asy_apm_synthetic_get_script_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`script_id`	(required) The OCID of the script.
`opc_request_id`	(optional) Unique 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://apm-synthetic.{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_DEDICATED_VANTAGE_POINTS Function

Returns a list of dedicated vantage points.

Syntax

FUNCTION list_dedicated_vantage_points (
  apm_domain_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  status 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_asy_apm_synthetic_list_dedicated_vantage_points_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The maximum number of results per page, or items to return in a paginated \"List\" call. For information on how pagination works, see List Pagination. Example: `50`
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Default sort order is ascending. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case-sensitive. Allowed values are: 'displayName', 'name', 'timeCreated', 'timeUpdated', 'status'
`display_name`	(optional) A filter to return only the resources that match the entire display name.
`name`	(optional) A filter to return only the resources that match the entire name.
`status`	(optional) A filter to return only the dedicated vantage points that match a given status. Allowed values are: 'ENABLED', 'DISABLED'
`opc_request_id`	(optional) Unique 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://apm-synthetic.{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_MONITORS Function

Returns a list of monitors.

Syntax

FUNCTION list_monitors (
  apm_domain_id varchar2,
  display_name varchar2 DEFAULT NULL,
  script_id varchar2 DEFAULT NULL,
  vantage_point varchar2 DEFAULT NULL,
  monitor_type varchar2 DEFAULT NULL,
  status varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  is_maintenance_window_active number DEFAULT NULL,
  is_maintenance_window_set number 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_asy_apm_synthetic_list_monitors_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`display_name`	(optional) A filter to return only the resources that match the entire display name.
`script_id`	(optional) A filter to return only monitors using scriptId.
`vantage_point`	(optional) The name of the public or dedicated vantage point.
`monitor_type`	(optional) A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
`status`	(optional) A filter to return only monitors that match the status given. Allowed values are: 'ENABLED', 'DISABLED', 'INVALID'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The maximum number of results per page, or items to return in a paginated \"List\" call. For information on how pagination works, see List Pagination. Example: `50`
`is_maintenance_window_active`	(optional) A filter to return the monitors whose maintenance window is currently active.
`is_maintenance_window_set`	(optional) A filter to return the monitors whose maintenance window is set.
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Default sort order is ascending. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case insensitive. Allowed values are: 'displayName', 'timeCreated', 'timeUpdated', 'status', 'monitorType', 'maintenanceWindowTimeStarted'
`opc_request_id`	(optional) Unique 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://apm-synthetic.{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_PUBLIC_VANTAGE_POINTS Function

Returns a list of public vantage points.

Syntax

FUNCTION list_public_vantage_points (
  apm_domain_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  name 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_asy_apm_synthetic_list_public_vantage_points_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The maximum number of results per page, or items to return in a paginated \"List\" call. For information on how pagination works, see List Pagination. Example: `50`
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Default sort order is ascending. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. You can provide one sort by (`sortBy`). Default order for displayName or name is ascending. The displayName or name sort by is case insensitive. Allowed values are: 'name', 'displayName'
`display_name`	(optional) A filter to return only the resources that match the entire display name.
`name`	(optional) A filter to return only the resources that match the entire name.
`opc_request_id`	(optional) Unique 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://apm-synthetic.{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_SCRIPTS Function

Returns a list of scripts.

Syntax

FUNCTION list_scripts (
  apm_domain_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  content_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_asy_apm_synthetic_list_scripts_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`display_name`	(optional) A filter to return only the resources that match the entire display name.
`content_type`	(optional) A filter to return only resources that match the content type given.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The maximum number of results per page, or items to return in a paginated \"List\" call. For information on how pagination works, see List Pagination. Example: `50`
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). Default sort order is ascending. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order of displayName and contentType is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case insensitive. Allowed values are: 'displayName', 'timeCreated', 'timeUpdated', 'contentType'
`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://apm-synthetic.{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_DEDICATED_VANTAGE_POINT Function

Updates the dedicated vantage point.

Syntax

FUNCTION update_dedicated_vantage_point (
  apm_domain_id varchar2,
  dedicated_vantage_point_id varchar2,
  update_dedicated_vantage_point_details dbms_cloud_oci_apm_synthetics_update_dedicated_vantage_point_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_asy_apm_synthetic_update_dedicated_vantage_point_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`dedicated_vantage_point_id`	(required) The OCID of the dedicated vantage point.
`update_dedicated_vantage_point_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) Unique 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://apm-synthetic.{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_MONITOR Function

Updates the monitor.

Syntax

FUNCTION update_monitor (
  apm_domain_id varchar2,
  monitor_id varchar2,
  update_monitor_details dbms_cloud_oci_apm_synthetics_update_monitor_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_asy_apm_synthetic_update_monitor_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`monitor_id`	(required) The OCID of the monitor.
`update_monitor_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) Unique 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://apm-synthetic.{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_SCRIPT Function

Updates the script.

Syntax

FUNCTION update_script (
  apm_domain_id varchar2,
  script_id varchar2,
  update_script_details dbms_cloud_oci_apm_synthetics_update_script_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_asy_apm_synthetic_update_script_response_t;

Parameters

Parameter	Description
`apm_domain_id`	(required) The APM domain ID the request is intended for.
`script_id`	(required) The OCID of the script.
`update_script_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) Unique 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://apm-synthetic.{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 Try Free Tier

AGGREGATE_NETWORK_DATA Function 🔗

CREATE_DEDICATED_VANTAGE_POINT Function 🔗

CREATE_MONITOR Function 🔗

CREATE_SCRIPT Function 🔗

DELETE_DEDICATED_VANTAGE_POINT Function 🔗

DELETE_MONITOR Function 🔗

DELETE_SCRIPT Function 🔗

GET_DEDICATED_VANTAGE_POINT Function 🔗

GET_MONITOR Function 🔗

GET_MONITOR_RESULT Function 🔗

GET_SCRIPT Function 🔗

LIST_DEDICATED_VANTAGE_POINTS Function 🔗

LIST_MONITORS Function 🔗

LIST_PUBLIC_VANTAGE_POINTS Function 🔗

LIST_SCRIPTS Function 🔗

UPDATE_DEDICATED_VANTAGE_POINT Function 🔗

UPDATE_MONITOR Function 🔗

UPDATE_SCRIPT Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

AGGREGATE_NETWORK_DATA Function

CREATE_DEDICATED_VANTAGE_POINT Function

CREATE_MONITOR Function

CREATE_SCRIPT Function

DELETE_DEDICATED_VANTAGE_POINT Function

DELETE_MONITOR Function

DELETE_SCRIPT Function

GET_DEDICATED_VANTAGE_POINT Function

GET_MONITOR Function

GET_MONITOR_RESULT Function

GET_SCRIPT Function

LIST_DEDICATED_VANTAGE_POINTS Function

LIST_MONITORS Function

LIST_PUBLIC_VANTAGE_POINTS Function

LIST_SCRIPTS Function

UPDATE_DEDICATED_VANTAGE_POINT Function

UPDATE_MONITOR Function

UPDATE_SCRIPT Function