Roving Edge Infrastructure Cluster Functions

Package: DBMS_CLOUD_OCI_RV_ROVER_CLUSTER

CHANGE_ROVER_CLUSTER_COMPARTMENT Function

Moves a cluster into a different compartment.

Syntax

FUNCTION change_rover_cluster_compartment (
  rover_cluster_id varchar2,
  change_rover_cluster_compartment_details dbms_cloud_oci_rover_change_rover_cluster_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rv_rover_cluster_change_rover_cluster_compartment_response_t;

Parameters

Parameter	Description
`rover_cluster_id`	(required) Unique RoverCluster identifier
`change_rover_cluster_compartment_details`	(required) CompartmentId of the destination compartment
`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.
`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.
`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://rover.{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_ROVER_CLUSTER Function

Creates a new RoverCluster.

Syntax

FUNCTION create_rover_cluster (
  create_rover_cluster_details dbms_cloud_oci_rover_create_rover_cluster_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_rv_rover_cluster_create_rover_cluster_response_t;

Parameters

Parameter	Description
`create_rover_cluster_details`	(required) Details for the new RoverCluster.
`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://rover.{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_ROVER_CLUSTER Function

Deletes a RoverCluster resource by identifier

Syntax

FUNCTION delete_rover_cluster (
  rover_cluster_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rv_rover_cluster_delete_rover_cluster_response_t;

Parameters

Parameter	Description
`rover_cluster_id`	(required) Unique RoverCluster identifier
`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.
`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.
`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://rover.{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_ROVER_CLUSTER Function

Gets a RoverCluster by identifier

Syntax

FUNCTION get_rover_cluster (
  rover_cluster_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_rv_rover_cluster_get_rover_cluster_response_t;

Parameters

Parameter	Description
`rover_cluster_id`	(required) Unique RoverCluster identifier
`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://rover.{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_ROVER_CLUSTER_CERTIFICATE Function

Get the certificate for a rover cluster

Syntax

FUNCTION get_rover_cluster_certificate (
  rover_cluster_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_rv_rover_cluster_get_rover_cluster_certificate_response_t;

Parameters

Parameter	Description
`rover_cluster_id`	(required) Unique RoverCluster identifier
`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://rover.{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_ROVER_CLUSTERS Function

Returns a list of RoverClusters.

Syntax

FUNCTION list_rover_clusters (
  compartment_id varchar2,
  display_name varchar2 DEFAULT NULL,
  cluster_type varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  lifecycle_state 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_rv_rover_cluster_list_rover_clusters_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment in which to list resources.
`display_name`	(optional) A filter to return only resources that match the entire display name given.
`cluster_type`	(optional) A filter to return only Clusters of type matched with the given cluster type. Allowed values are: 'STANDALONE', 'STATION'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`lifecycle_state`	(optional) A filter to return only resources their lifecycleState matches the given lifecycleState. Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'
`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://rover.{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.

REQUEST_ADDITIONAL_NODES Function

Submit additional nodes request for a roverCluster.

Syntax

FUNCTION request_additional_nodes (
  rover_cluster_id varchar2,
  request_additional_nodes_details dbms_cloud_oci_rover_request_additional_nodes_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rv_rover_cluster_request_additional_nodes_response_t;

Parameters

Parameter	Description
`rover_cluster_id`	(required) Unique RoverCluster identifier
`request_additional_nodes_details`	(required) Details object to request additional nodes.
`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.
`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.
`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://rover.{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_ROVER_CLUSTER Function

Updates the RoverCluster

Syntax

FUNCTION update_rover_cluster (
  rover_cluster_id varchar2,
  update_rover_cluster_details dbms_cloud_oci_rover_update_rover_cluster_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_rv_rover_cluster_update_rover_cluster_response_t;

Parameters

Parameter	Description
`rover_cluster_id`	(required) Unique RoverCluster identifier
`update_rover_cluster_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://rover.{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

CHANGE_ROVER_CLUSTER_COMPARTMENT Function

CREATE_ROVER_CLUSTER Function

DELETE_ROVER_CLUSTER Function

GET_ROVER_CLUSTER Function

GET_ROVER_CLUSTER_CERTIFICATE Function

LIST_ROVER_CLUSTERS Function

REQUEST_ADDITIONAL_NODES Function

UPDATE_ROVER_CLUSTER Function