Oracle Cloud Infrastructure Documentation
Try Free Tier

Service Manager Proxy Functions

Package: DBMS_CLOUD_OCI_SMP_SERVICE_MANAGER_PROXY

GET_SERVICE_ENVIRONMENT Function

Get the detailed information for a specific service environment.

Syntax

FUNCTION get_service_environment (
  service_environment_id varchar2,
  compartment_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_smp_service_manager_proxy_get_service_environment_response_t;

Parameters

Parameter Description

service_environment_id

(required) The unique identifier associated with the service environment. **Note:** Not an OCID.

compartment_id

(required) The OCID for the compartment.

opc_request_id

(optional) 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://smproxy.{region}.ocs.{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_SERVICE_ENVIRONMENTS Function

List the details of Software as a Service (SaaS) environments provisioned by Service Manager. Information includes the service instance endpoints and service definition details.

Syntax

FUNCTION list_service_environments (
  compartment_id varchar2,
  service_environment_id varchar2 DEFAULT NULL,
  service_environment_type varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_smp_service_manager_proxy_list_service_environments_response_t;

Parameters

Parameter Description

compartment_id

(required) The OCID for the compartment.

service_environment_id

(optional) The unique identifier associated with the service environment. **Note:** Not an OCID.

service_environment_type

(optional) The environment's service definition type. For example, \"RGBUOROMS\" is the service definition type for \"Oracle Retail Order Management Cloud Service\".

opc_request_id

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

limit

(optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.

page

(optional) The value of the `opc-next-page` response header from the previous \"List\" call.

sort_by

(optional) The field to sort by. Only one sort order may be provided. ID is default ordered as ascending.

Allowed values are: 'ID'

sort_order

(optional) The sort order to use, either `ASC` or `DESC`.

Allowed values are: 'ASC', 'DESC'

display_name

(optional) The display name of the resource.

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://smproxy.{region}.ocs.{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.

Was this article helpful?