Container Engine Functions

CLUSTER_MIGRATE_TO_NATIVE_VCN Function

Initiates cluster migration to use native VCN.

Syntax

FUNCTION cluster_migrate_to_native_vcn (
  cluster_id varchar2,
  cluster_migrate_to_native_vcn_details dbms_cloud_oci_container_engine_cluster_migrate_to_native_vcn_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_ce_container_engine_cluster_migrate_to_native_vcn_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`cluster_migrate_to_native_vcn_details`	(required) The details for the cluster's migration to native VCN.
`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 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://containerengine.{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.

COMPLETE_CREDENTIAL_ROTATION Function

Complete cluster credential rotation. Retire old credentials from kubernetes components.

Syntax

FUNCTION complete_credential_rotation (
  cluster_id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_complete_credential_rotation_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`opc_retry_token`	(optional) A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
`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.
`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.
`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://containerengine.{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_CLUSTER Function

Create a new cluster.

Syntax

FUNCTION create_cluster (
  create_cluster_details dbms_cloud_oci_container_engine_create_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_ce_container_engine_create_cluster_response_t;

Parameters

Parameter	Description
`create_cluster_details`	(required) The details of the cluster to create.
`opc_retry_token`	(optional) A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
`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://containerengine.{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_KUBECONFIG Function

Create the Kubeconfig YAML for a cluster.

Syntax

FUNCTION create_kubeconfig (
  cluster_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  create_cluster_kubeconfig_content_details dbms_cloud_oci_container_engine_create_cluster_kubeconfig_content_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_create_kubeconfig_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`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.
`create_cluster_kubeconfig_content_details`	(optional) The details of the cluster kubeconfig to create.
`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://containerengine.{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_NODE_POOL Function

Create a new node pool.

Syntax

FUNCTION create_node_pool (
  create_node_pool_details dbms_cloud_oci_container_engine_create_node_pool_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_ce_container_engine_create_node_pool_response_t;

Parameters

Parameter	Description
`create_node_pool_details`	(required) The details of the node pool to create.
`opc_retry_token`	(optional) A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
`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://containerengine.{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_VIRTUAL_NODE_POOL Function

Create a new virtual node pool.

Syntax

FUNCTION create_virtual_node_pool (
  create_virtual_node_pool_details dbms_cloud_oci_container_engine_create_virtual_node_pool_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_ce_container_engine_create_virtual_node_pool_response_t;

Parameters

Parameter	Description
`create_virtual_node_pool_details`	(required) The details of the virtual node pool to create.
`opc_retry_token`	(optional) A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
`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://containerengine.{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_WORKLOAD_MAPPING Function

Create the specified workloadMapping for a cluster.

Syntax

FUNCTION create_workload_mapping (
  cluster_id varchar2,
  create_workload_mapping_details dbms_cloud_oci_container_engine_create_workload_mapping_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_ce_container_engine_create_workload_mapping_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`create_workload_mapping_details`	(required) The details of the workloadMapping to be create.
`opc_retry_token`	(optional) A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
`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://containerengine.{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_CLUSTER Function

Delete a cluster.

Syntax

FUNCTION delete_cluster (
  cluster_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_ce_container_engine_delete_cluster_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`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 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://containerengine.{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_NODE Function

Delete node.

Syntax

FUNCTION delete_node (
  node_pool_id varchar2,
  node_id varchar2,
  is_decrement_size number DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  override_eviction_grace_duration varchar2 DEFAULT NULL,
  is_force_deletion_after_override_grace_duration number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_delete_node_response_t;

Parameters

Parameter	Description
`node_pool_id`	(required) The OCID of the node pool.
`node_id`	(required) The OCID of the compute instance.
`is_decrement_size`	(optional) If the nodepool should be scaled down after the node is deleted.
`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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`override_eviction_grace_duration`	(optional) Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
`is_force_deletion_after_override_grace_duration`	(optional) If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
`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://containerengine.{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_NODE_POOL Function

Delete a node pool.

Syntax

FUNCTION delete_node_pool (
  node_pool_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  override_eviction_grace_duration varchar2 DEFAULT NULL,
  is_force_deletion_after_override_grace_duration number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_delete_node_pool_response_t;

Parameters

Parameter	Description
`node_pool_id`	(required) The OCID of the node pool.
`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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`override_eviction_grace_duration`	(optional) Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
`is_force_deletion_after_override_grace_duration`	(optional) If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
`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://containerengine.{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_VIRTUAL_NODE_POOL Function

Delete a virtual node pool.

Syntax

FUNCTION delete_virtual_node_pool (
  virtual_node_pool_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  override_eviction_grace_duration_vnp varchar2 DEFAULT NULL,
  is_force_deletion_after_override_grace_duration_vnp number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_delete_virtual_node_pool_response_t;

Parameters

Parameter	Description
`virtual_node_pool_id`	(required) The OCID of the virtual node pool.
`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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`override_eviction_grace_duration_vnp`	(optional) Duration after which Sk8s will give up eviction of the pods on the node. PT0M will indicate you want to delete the virtual node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
`is_force_deletion_after_override_grace_duration_vnp`	(optional) If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
`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://containerengine.{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_WORK_REQUEST Function

Cancel a work request that has not started.

Syntax

FUNCTION delete_work_request (
  work_request_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_ce_container_engine_delete_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`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 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://containerengine.{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_WORKLOAD_MAPPING Function

Delete workloadMapping for a provisioned cluster.

Syntax

FUNCTION delete_workload_mapping (
  cluster_id varchar2,
  workload_mapping_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_ce_container_engine_delete_workload_mapping_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`workload_mapping_id`	(required) The OCID of the workloadMapping.
`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 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://containerengine.{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.

DISABLE_ADDON Function

Disable addon for a provisioned cluster.

Syntax

FUNCTION disable_addon (
  cluster_id varchar2,
  addon_name varchar2,
  is_remove_existing_add_on number,
  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_ce_container_engine_disable_addon_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`addon_name`	(required) The name of the addon.
`is_remove_existing_add_on`	(required) Whether existing addon resources should be deleted or not. True would remove the underlying resources completely.
`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 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://containerengine.{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_ADDON Function

Get the specified addon for a cluster.

Syntax

FUNCTION get_addon (
  cluster_id varchar2,
  addon_name varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_get_addon_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`addon_name`	(required) The name of the addon.
`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://containerengine.{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_CLUSTER Function

Get the details of a cluster.

Syntax

FUNCTION get_cluster (
  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_ce_container_engine_get_cluster_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`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://containerengine.{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_CLUSTER_MIGRATE_TO_NATIVE_VCN_STATUS Function

Get details on a cluster's migration to native VCN.

Syntax

FUNCTION get_cluster_migrate_to_native_vcn_status (
  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_ce_container_engine_get_cluster_migrate_to_native_vcn_status_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`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://containerengine.{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_CLUSTER_OPTIONS Function

Get options available for clusters.

Syntax

FUNCTION get_cluster_options (
  cluster_option_id varchar2,
  compartment_id 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_ce_container_engine_get_cluster_options_response_t;

Parameters

Parameter	Description
`cluster_option_id`	(required) The id of the option set to retrieve. Use \"all\" get all options, or use a cluster ID to get options specific to the provided cluster.
`compartment_id`	(optional) The OCID of 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://containerengine.{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_CREDENTIAL_ROTATION_STATUS Function

Get cluster credential rotation status.

Syntax

FUNCTION get_credential_rotation_status (
  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_ce_container_engine_get_credential_rotation_status_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`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://containerengine.{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_NODE_POOL Function

Get the details of a node pool.

Syntax

FUNCTION get_node_pool (
  node_pool_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_ce_container_engine_get_node_pool_response_t;

Parameters

Parameter	Description
`node_pool_id`	(required) The OCID of the node pool.
`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://containerengine.{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_NODE_POOL_OPTIONS Function

Get options available for node pools.

Syntax

FUNCTION get_node_pool_options (
  node_pool_option_id varchar2,
  compartment_id 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_ce_container_engine_get_node_pool_options_response_t;

Parameters

Parameter	Description
`node_pool_option_id`	(required) The id of the option set to retrieve. Use \"all\" get all options, or use a cluster ID to get options specific to the provided cluster.
`compartment_id`	(optional) The OCID of 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://containerengine.{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_VIRTUAL_NODE Function

Get the details of a virtual node.

Syntax

FUNCTION get_virtual_node (
  virtual_node_pool_id varchar2,
  virtual_node_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_ce_container_engine_get_virtual_node_response_t;

Parameters

Parameter	Description
`virtual_node_pool_id`	(required) The OCID of the virtual node pool.
`virtual_node_id`	(required) The OCID of the virtual node.
`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://containerengine.{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_VIRTUAL_NODE_POOL Function

Get the details of a virtual node pool.

Syntax

FUNCTION get_virtual_node_pool (
  virtual_node_pool_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_ce_container_engine_get_virtual_node_pool_response_t;

Parameters

Parameter	Description
`virtual_node_pool_id`	(required) The OCID of the virtual node pool.
`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://containerengine.{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_WORK_REQUEST Function

Get the details of a work request.

Syntax

FUNCTION get_work_request (
  work_request_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_ce_container_engine_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The OCID of the work request.
`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://containerengine.{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_WORKLOAD_MAPPING Function

Get the specified workloadMapping for a cluster.

Syntax

FUNCTION get_workload_mapping (
  cluster_id varchar2,
  workload_mapping_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_ce_container_engine_get_workload_mapping_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`workload_mapping_id`	(required) The OCID of the workloadMapping.
`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://containerengine.{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.

INSTALL_ADDON Function

Install the specified addon for a cluster.

Syntax

FUNCTION install_addon (
  cluster_id varchar2,
  install_addon_details dbms_cloud_oci_container_engine_install_addon_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_install_addon_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`install_addon_details`	(required) The details of the addon to be installed.
`opc_retry_token`	(optional) A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
`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.
`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.
`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://containerengine.{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_ADDON_OPTIONS Function

Get list of supported addons for a specific kubernetes version.

Syntax

FUNCTION list_addon_options (
  kubernetes_version varchar2,
  addon_name varchar2 DEFAULT NULL,
  opc_request_id 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_ce_container_engine_list_addon_options_response_t;

Parameters

Parameter	Description
`kubernetes_version`	(required) The kubernetes version to fetch the addons.
`addon_name`	(optional) The name of the addon.
`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) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The optional order in which to sort the results. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The optional field to sort the results by. Allowed values are: 'NAME', 'TIME_CREATED'
`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://containerengine.{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_ADDONS Function

List addon for a provisioned cluster.

Syntax

FUNCTION list_addons (
  cluster_id varchar2,
  opc_request_id 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_ce_container_engine_list_addons_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`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) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The optional order in which to sort the results. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The optional field to sort the results by. Allowed values are: 'NAME', 'TIME_CREATED'
`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://containerengine.{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_CLUSTERS Function

List all the cluster objects in a compartment.

Syntax

FUNCTION list_clusters (
  compartment_id varchar2,
  lifecycle_state dbms_cloud_oci_container_engine_varchar2_tbl DEFAULT NULL,
  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_ce_container_engine_list_clusters_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`lifecycle_state`	(optional) A cluster lifecycle state to filter on. Can have multiple parameters of this name. Allowed values are: 'CREATING', 'ACTIVE', 'FAILED', 'DELETING', 'DELETED', 'UPDATING'
`name`	(optional) The name to filter on.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The optional order in which to sort the results. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The optional field to sort the results by. Allowed values are: 'ID', 'NAME', 'TIME_CREATED'
`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://containerengine.{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_NODE_POOLS Function

List all the node pools in a compartment, and optionally filter by cluster.

Syntax

FUNCTION list_node_pools (
  compartment_id varchar2,
  cluster_id varchar2 DEFAULT NULL,
  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,
  lifecycle_state dbms_cloud_oci_container_engine_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_list_node_pools_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`cluster_id`	(optional) The OCID of the cluster.
`name`	(optional) The name to filter on.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The optional order in which to sort the results. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The optional field to sort the results by. Allowed values are: 'ID', 'NAME', 'TIME_CREATED'
`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.
`lifecycle_state`	(optional) A list of nodepool lifecycle states on which to filter on, matching any of the list items (OR logic). eg. [ACTIVE, DELETING] Allowed values are: 'DELETED', 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'FAILED', 'INACTIVE', 'NEEDS_ATTENTION'
`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://containerengine.{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_POD_SHAPES Function

List all the Pod Shapes in a compartment.

Syntax

FUNCTION list_pod_shapes (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  name 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_ce_container_engine_list_pod_shapes_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of 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.
`availability_domain`	(optional) The availability domain of the pod shape.
`name`	(optional) The name to filter on.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The optional order in which to sort the results. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The optional field to sort the results by. Allowed values are: 'ID', 'NAME', 'TIME_CREATED'
`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://containerengine.{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_VIRTUAL_NODE_POOLS Function

List all the virtual node pools in a compartment, and optionally filter by cluster.

Syntax

FUNCTION list_virtual_node_pools (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  cluster_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  lifecycle_state dbms_cloud_oci_container_engine_varchar2_tbl DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_list_virtual_node_pools_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of 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.
`cluster_id`	(optional) The OCID of the cluster.
`name`	(optional) The name to filter on.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The optional order in which to sort the results. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The optional field to sort the results by. Allowed values are: 'ID', 'NAME', 'TIME_CREATED'
`lifecycle_state`	(optional) A virtual node pool lifecycle state to filter on. Can have multiple parameters of this name. Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED', 'NEEDS_ATTENTION'
`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://containerengine.{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_VIRTUAL_NODES Function

List virtual nodes in a virtual node pool.

Syntax

FUNCTION list_virtual_nodes (
  virtual_node_pool_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  name 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_ce_container_engine_list_virtual_nodes_response_t;

Parameters

Parameter	Description
`virtual_node_pool_id`	(required) The OCID of the virtual node pool.
`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.
`name`	(optional) The name to filter on.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The optional order in which to sort the results. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The optional field to sort the results by. Allowed values are: 'ID', 'NAME', 'TIME_CREATED'
`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://containerengine.{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_WORK_REQUEST_ERRORS Function

Get the errors of a work request.

Syntax

FUNCTION list_work_request_errors (
  compartment_id varchar2,
  work_request_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_ce_container_engine_list_work_request_errors_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`work_request_id`	(required) The OCID of the work request.
`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://containerengine.{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_WORK_REQUEST_LOGS Function

Get the logs of a work request.

Syntax

FUNCTION list_work_request_logs (
  compartment_id varchar2,
  work_request_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_ce_container_engine_list_work_request_logs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`work_request_id`	(required) The OCID of the work request.
`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://containerengine.{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_WORK_REQUESTS Function

List all work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  cluster_id varchar2 DEFAULT NULL,
  resource_id varchar2 DEFAULT NULL,
  resource_type varchar2 DEFAULT NULL,
  status dbms_cloud_oci_container_engine_varchar2_tbl 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_ce_container_engine_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`cluster_id`	(optional) The OCID of the cluster.
`resource_id`	(optional) The OCID of the resource associated with a work request
`resource_type`	(optional) Type of the resource associated with a work request Allowed values are: 'CLUSTER', 'NODEPOOL'
`status`	(optional) A work request status to filter on. Can have multiple parameters of this name.
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The optional order in which to sort the results. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The optional field to sort the results by. Allowed values are: 'ID', 'OPERATION_TYPE', 'STATUS', 'TIME_ACCEPTED', 'TIME_STARTED', 'TIME_FINISHED'
`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://containerengine.{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_WORKLOAD_MAPPINGS Function

List workloadMappings for a provisioned cluster.

Syntax

FUNCTION list_workload_mappings (
  cluster_id varchar2,
  opc_request_id 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_ce_container_engine_list_workload_mappings_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`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) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination.
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`sort_order`	(optional) The optional order in which to sort the results. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The optional field to sort the results by. Allowed values are: 'NAMESPACE', 'TIMECREATED'
`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://containerengine.{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.

START_CREDENTIAL_ROTATION Function

Start cluster credential rotation by adding new credentials, old credentials will still work after this operation.

Syntax

FUNCTION start_credential_rotation (
  cluster_id varchar2,
  start_credential_rotation_details dbms_cloud_oci_container_engine_start_credential_rotation_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_start_credential_rotation_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`start_credential_rotation_details`	(required) The details for a kubernetes cluster to start credential rotation.
`opc_retry_token`	(optional) A token you supply to uniquely identify the request and provide idempotency if the request is retried. Idempotency tokens expire after 24 hours.
`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.
`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.
`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://containerengine.{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_ADDON Function

Update addon details for a cluster.

Syntax

FUNCTION update_addon (
  cluster_id varchar2,
  addon_name varchar2,
  update_addon_details dbms_cloud_oci_container_engine_update_addon_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_ce_container_engine_update_addon_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`addon_name`	(required) The name of the addon.
`update_addon_details`	(required) The details of the addon 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 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://containerengine.{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_CLUSTER Function

Update the details of a cluster.

Syntax

FUNCTION update_cluster (
  cluster_id varchar2,
  update_cluster_details dbms_cloud_oci_container_engine_update_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_ce_container_engine_update_cluster_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`update_cluster_details`	(required) The details of the cluster to update.
`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 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://containerengine.{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_CLUSTER_ENDPOINT_CONFIG Function

Update the details of the cluster endpoint configuration.

Syntax

FUNCTION update_cluster_endpoint_config (
  cluster_id varchar2,
  update_cluster_endpoint_config_details dbms_cloud_oci_container_engine_update_cluster_endpoint_config_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_ce_container_engine_update_cluster_endpoint_config_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`update_cluster_endpoint_config_details`	(required) The details of the cluster's endpoint to update.
`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 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://containerengine.{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_NODE_POOL Function

Update the details of a node pool.

Syntax

FUNCTION update_node_pool (
  node_pool_id varchar2,
  update_node_pool_details dbms_cloud_oci_container_engine_update_node_pool_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  override_eviction_grace_duration varchar2 DEFAULT NULL,
  is_force_deletion_after_override_grace_duration number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ce_container_engine_update_node_pool_response_t;

Parameters

Parameter	Description
`node_pool_id`	(required) The OCID of the node pool.
`update_node_pool_details`	(required) The fields to update in a node pool.
`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 Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`override_eviction_grace_duration`	(optional) Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M
`is_force_deletion_after_override_grace_duration`	(optional) If the underlying compute instance should be deleted if you cannot evict all the pods in grace period
`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://containerengine.{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_VIRTUAL_NODE_POOL Function

Update the details of a virtual node pool.

Syntax

FUNCTION update_virtual_node_pool (
  virtual_node_pool_id varchar2,
  update_virtual_node_pool_details dbms_cloud_oci_container_engine_update_virtual_node_pool_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_ce_container_engine_update_virtual_node_pool_response_t;

Parameters

Parameter	Description
`virtual_node_pool_id`	(required) The OCID of the virtual node pool.
`update_virtual_node_pool_details`	(required) The fields to update in a virtual node pool.
`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 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://containerengine.{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_WORKLOAD_MAPPING Function

Update workloadMapping details for a cluster.

Syntax

FUNCTION update_workload_mapping (
  cluster_id varchar2,
  workload_mapping_id varchar2,
  update_workload_mapping_details dbms_cloud_oci_container_engine_update_workload_mapping_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_ce_container_engine_update_workload_mapping_response_t;

Parameters

Parameter	Description
`cluster_id`	(required) The OCID of the cluster.
`workload_mapping_id`	(required) The OCID of the workloadMapping.
`update_workload_mapping_details`	(required) The details of the workloadMapping 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 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://containerengine.{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

CLUSTER_MIGRATE_TO_NATIVE_VCN Function 🔗

COMPLETE_CREDENTIAL_ROTATION Function 🔗

CREATE_CLUSTER Function 🔗

CREATE_KUBECONFIG Function 🔗

CREATE_NODE_POOL Function 🔗

CREATE_VIRTUAL_NODE_POOL Function 🔗

CREATE_WORKLOAD_MAPPING Function 🔗

DELETE_CLUSTER Function 🔗

DELETE_NODE Function 🔗

DELETE_NODE_POOL Function 🔗

DELETE_VIRTUAL_NODE_POOL Function 🔗

DELETE_WORK_REQUEST Function 🔗

DELETE_WORKLOAD_MAPPING Function 🔗

DISABLE_ADDON Function 🔗

GET_ADDON Function 🔗

GET_CLUSTER Function 🔗

GET_CLUSTER_MIGRATE_TO_NATIVE_VCN_STATUS Function 🔗

GET_CLUSTER_OPTIONS Function 🔗

GET_CREDENTIAL_ROTATION_STATUS Function 🔗

GET_NODE_POOL Function 🔗

GET_NODE_POOL_OPTIONS Function 🔗

GET_VIRTUAL_NODE Function 🔗

GET_VIRTUAL_NODE_POOL Function 🔗

GET_WORK_REQUEST Function 🔗

GET_WORKLOAD_MAPPING Function 🔗

INSTALL_ADDON Function 🔗

LIST_ADDON_OPTIONS Function 🔗

LIST_ADDONS Function 🔗

LIST_CLUSTERS Function 🔗

LIST_NODE_POOLS Function 🔗

LIST_POD_SHAPES Function 🔗

LIST_VIRTUAL_NODE_POOLS Function 🔗

LIST_VIRTUAL_NODES Function 🔗

LIST_WORK_REQUEST_ERRORS Function 🔗

LIST_WORK_REQUEST_LOGS Function 🔗

LIST_WORK_REQUESTS Function 🔗

LIST_WORKLOAD_MAPPINGS Function 🔗

START_CREDENTIAL_ROTATION Function 🔗

UPDATE_ADDON Function 🔗

UPDATE_CLUSTER Function 🔗

UPDATE_CLUSTER_ENDPOINT_CONFIG Function 🔗

UPDATE_NODE_POOL Function 🔗

UPDATE_VIRTUAL_NODE_POOL Function 🔗

UPDATE_WORKLOAD_MAPPING Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

CLUSTER_MIGRATE_TO_NATIVE_VCN Function

COMPLETE_CREDENTIAL_ROTATION Function

CREATE_CLUSTER Function

CREATE_KUBECONFIG Function

CREATE_NODE_POOL Function

CREATE_VIRTUAL_NODE_POOL Function

CREATE_WORKLOAD_MAPPING Function

DELETE_CLUSTER Function

DELETE_NODE Function

DELETE_NODE_POOL Function

DELETE_VIRTUAL_NODE_POOL Function

DELETE_WORK_REQUEST Function

DELETE_WORKLOAD_MAPPING Function

DISABLE_ADDON Function

GET_ADDON Function

GET_CLUSTER Function

GET_CLUSTER_MIGRATE_TO_NATIVE_VCN_STATUS Function

GET_CLUSTER_OPTIONS Function

GET_CREDENTIAL_ROTATION_STATUS Function

GET_NODE_POOL Function

GET_NODE_POOL_OPTIONS Function

GET_VIRTUAL_NODE Function

GET_VIRTUAL_NODE_POOL Function

GET_WORK_REQUEST Function

GET_WORKLOAD_MAPPING Function

INSTALL_ADDON Function

LIST_ADDON_OPTIONS Function

LIST_ADDONS Function

LIST_CLUSTERS Function

LIST_NODE_POOLS Function

LIST_POD_SHAPES Function

LIST_VIRTUAL_NODE_POOLS Function

LIST_VIRTUAL_NODES Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

LIST_WORKLOAD_MAPPINGS Function

START_CREDENTIAL_ROTATION Function

UPDATE_ADDON Function

UPDATE_CLUSTER Function

UPDATE_CLUSTER_ENDPOINT_CONFIG Function

UPDATE_NODE_POOL Function

UPDATE_VIRTUAL_NODE_POOL Function

UPDATE_WORKLOAD_MAPPING Function