ServiceManagerProxyClient¶

class oci.service_manager_proxy.ServiceManagerProxyClient(config, **kwargs)¶

Use the Service Manager Proxy API to obtain information about SaaS environments provisioned by Service Manager. You can get information such as service types and service environment URLs.

Methods

`__init__`(config, **kwargs)	Creates a new service client
`get_service_environment`(…)	Get the detailed information for a specific service environment.
`list_service_environments`(compartment_id, …)	List the details of Software as a Service (SaaS) environments provisioned by Service Manager.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

get_service_environment(service_environment_id, compartment_id, **kwargs)¶

Get the detailed information for a specific service environment.

Parameters:	service_environment_id (str) – (required) The unique identifier associated with the service environment. Note: Not an OCID. compartment_id (str) – (required) The OCID for the compartment. opc_request_id (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ServiceEnvironment`
Return type:	`Response`
Example:

Click here to see an example of how to use get_service_environment API.

list_service_environments(compartment_id, **kwargs)¶

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

Parameters:	compartment_id (str) – (required) The OCID for the compartment. service_environment_id (str) – (optional) The unique identifier associated with the service environment. Note: Not an OCID. service_environment_type (str) – (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 (str) – (optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. limit (int) – (optional) How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. page (str) – (optional) The value of the opc-next-page response header from the previous “List” call. sort_by (str) – (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 (str) – (optional) The sort order to use, either ASC or DESC. Allowed values are: “ASC”, “DESC” display_name (str) – (optional) The display name of the resource. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ServiceEnvironmentCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_service_environments API.