Core Compute Functions
Package: DBMS_CLOUD_OCI_CR_COMPUTE
ACCEPT_SHIELDED_INTEGRITY_POLICY Function
Accept the changes to the PCR values in the measured boot report.
Syntax
FUNCTION accept_shielded_integrity_policy (
instance_id varchar2,
opc_request_id varchar2 DEFAULT NULL,
if_match 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_cr_compute_accept_shielded_integrity_policy_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
ADD_IMAGE_SHAPE_COMPATIBILITY_ENTRY Function
Adds a shape to the compatible shapes list for the image.
Syntax
FUNCTION add_image_shape_compatibility_entry (
image_id varchar2,
shape_name varchar2,
add_image_shape_compatibility_entry_details dbms_cloud_oci_core_add_image_shape_compatibility_entry_details_t DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_add_image_shape_compatibility_entry_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the image. |
|
|
(required) Shape name. |
|
|
(optional) Image shape compatibility details |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
ATTACH_BOOT_VOLUME Function
Attaches the specified boot volume to the specified instance.
Syntax
FUNCTION attach_boot_volume (
attach_boot_volume_details dbms_cloud_oci_core_attach_boot_volume_details_t,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_attach_boot_volume_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Attach boot volume request |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
ATTACH_VNIC Function
Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see Virtual Network Interface Cards (VNICs).
Syntax
FUNCTION attach_vnic (
attach_vnic_details dbms_cloud_oci_core_attach_vnic_details_t,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_attach_vnic_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Attach VNIC details. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
ATTACH_VOLUME Function
Attaches the specified storage volume to the specified instance.
Syntax
FUNCTION attach_volume (
attach_volume_details dbms_cloud_oci_core_attach_volume_details_t,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_attach_volume_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Attach volume request |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CAPTURE_CONSOLE_HISTORY Function
Captures the most recent serial console data (up to a megabyte) for the specified instance. The `CaptureConsoleHistory` operation works with the other console history operations as described below. 1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the most recent console history. This call returns a `ConsoleHistory` object. The object will have a state of REQUESTED. 2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with the identifier of the console history metadata. The state of the `ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and then SUCCEEDED (or FAILED). 3. Use `GetConsoleHistoryContent` to get the actual console history data (not the metadata). 4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata and the console history data.
Syntax
FUNCTION capture_console_history (
capture_console_history_details dbms_cloud_oci_core_capture_console_history_details_t,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_capture_console_history_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Console history details |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_COMPUTE_CAPACITY_RESERVATION_COMPARTMENT Function
Moves a compute capacity reservation into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Syntax
FUNCTION change_compute_capacity_reservation_compartment (
capacity_reservation_id varchar2,
change_compute_capacity_reservation_compartment_details dbms_cloud_oci_core_change_compute_capacity_reservation_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_cr_compute_change_compute_capacity_reservation_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity reservation. |
|
|
(required) The configuration details for the move operation. |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_COMPUTE_CAPACITY_TOPOLOGY_COMPARTMENT Function
Moves a compute capacity topology into a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Syntax
FUNCTION change_compute_capacity_topology_compartment (
compute_capacity_topology_id varchar2,
change_compute_capacity_topology_compartment_details dbms_cloud_oci_core_change_compute_capacity_topology_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_cr_compute_change_compute_capacity_topology_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity topology. |
|
|
(required) The configuration details for the move operation. |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_COMPUTE_CLUSTER_COMPARTMENT Function
Moves a compute cluster into a different compartment within the same tenancy. A compute cluster is a remote direct memory access (RDMA) network group. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Syntax
FUNCTION change_compute_cluster_compartment (
compute_cluster_id varchar2,
change_compute_cluster_compartment_details dbms_cloud_oci_core_change_compute_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_cr_compute_change_compute_cluster_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. |
|
|
(required) The request to move the compute cluster to a different compartment. |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_COMPUTE_IMAGE_CAPABILITY_SCHEMA_COMPARTMENT Function
Moves a compute image capability schema into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Syntax
FUNCTION change_compute_image_capability_schema_compartment (
compute_image_capability_schema_id varchar2,
change_compute_image_capability_schema_compartment_details dbms_cloud_oci_core_change_compute_image_capability_schema_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_cr_compute_change_compute_image_capability_schema_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The id of the compute image capability schema or the image ocid |
|
|
(required) Compute Image Capability Schema change compartment details |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_DEDICATED_VM_HOST_COMPARTMENT Function
Moves a dedicated virtual machine host from one compartment to another.
Syntax
FUNCTION change_dedicated_vm_host_compartment (
dedicated_vm_host_id varchar2,
change_dedicated_vm_host_compartment_details dbms_cloud_oci_core_change_dedicated_vm_host_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_cr_compute_change_dedicated_vm_host_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the dedicated VM host. |
|
|
(required) The request to move the dedicated virtual machine host to a different compartment. |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_IMAGE_COMPARTMENT Function
Moves an image into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Syntax
FUNCTION change_image_compartment (
image_id varchar2,
change_image_compartment_details dbms_cloud_oci_core_change_image_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_cr_compute_change_image_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the image. |
|
|
(required) Request to change the compartment of a given image. |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CHANGE_INSTANCE_COMPARTMENT Function
Moves an instance into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment. When you move an instance to a different compartment, associated resources such as boot volumes and VNICs are not moved.
Syntax
FUNCTION change_instance_compartment (
instance_id varchar2,
change_instance_compartment_details dbms_cloud_oci_core_change_instance_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_cr_compute_change_instance_compartment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(required) Request to change the compartment of a given instance. |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_APP_CATALOG_SUBSCRIPTION Function
Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.
Syntax
FUNCTION create_app_catalog_subscription (
create_app_catalog_subscription_details dbms_cloud_oci_core_create_app_catalog_subscription_details_t,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_create_app_catalog_subscription_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Request for the creation of a subscription for listing resource version for a compartment. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_COMPUTE_CAPACITY_REPORT Function
Generates a report of the host capacity within an availability domain that is available for you to create compute instances. Host capacity is the physical infrastructure that resources such as compute instances run on. Use the capacity report to determine whether sufficient capacity is available for a shape before you create an instance or change the shape of an instance.
Syntax
FUNCTION create_compute_capacity_report (
create_compute_capacity_report_details dbms_cloud_oci_core_create_compute_capacity_report_details_t,
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_cr_compute_create_compute_capacity_report_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Details for creating a new compute capacity report. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_COMPUTE_CAPACITY_RESERVATION Function
Creates a new compute capacity reservation in the specified compartment and availability domain. Compute capacity reservations let you reserve instances in a compartment. When you launch an instance using this reservation, you are assured that you have enough space for your instance, and you won't get out of capacity errors. For more information, see Reserved Capacity.
Syntax
FUNCTION create_compute_capacity_reservation (
create_compute_capacity_reservation_details dbms_cloud_oci_core_create_compute_capacity_reservation_details_t,
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_cr_compute_create_compute_capacity_reservation_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Details for creating a new compute capacity reservation. **Caution:** Avoid using any confidential information when you use the API to supply string values. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_COMPUTE_CAPACITY_TOPOLOGY Function
Creates a new compute capacity topology in the specified compartment and availability domain. Compute capacity topologies provide the RDMA network topology of your bare metal hosts so that you can launch instances on your bare metal hosts with targeted network locations. Compute capacity topologies report the health status of your bare metal hosts.
Syntax
FUNCTION create_compute_capacity_topology (
create_compute_capacity_topology_details dbms_cloud_oci_core_create_compute_capacity_topology_details_t,
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_cr_compute_create_compute_capacity_topology_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Details for creating a new compute capacity topology. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_COMPUTE_CLUSTER Function
Creates an empty compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. After the compute cluster is created, you can use the compute cluster's OCID with the LAUNCH_INSTANCE Function operation to create instances in the compute cluster. The instances must be created in the same compartment and availability domain as the cluster. Use compute clusters when you want to manage instances in the cluster individually, or when you want to use different types of instances in the RDMA network group. If you want predictable capacity for a specific number of identical instances that are managed as a group, create a cluster network that uses instance pools by using the CREATE_CLUSTER_NETWORK Function operation.
Syntax
FUNCTION create_compute_cluster (
create_compute_cluster_details dbms_cloud_oci_core_create_compute_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_cr_compute_create_compute_cluster_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The data for creating a compute cluster. A compute cluster is an empty remote direct memory access (RDMA) network group. After the compute cluster is created, you can use the compute cluster's OCID with the |
|
|
(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 may be rejected). |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_COMPUTE_IMAGE_CAPABILITY_SCHEMA Function
Creates compute image capability schema.
Syntax
FUNCTION create_compute_image_capability_schema (
create_compute_image_capability_schema_details dbms_cloud_oci_core_create_compute_image_capability_schema_details_t,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_create_compute_image_capability_schema_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Compute Image Capability Schema creation details |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_DEDICATED_VM_HOST Function
Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain. Dedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers that are a single tenant and not shared with other customers. For more information, see Dedicated Virtual Machine Hosts.
Syntax
FUNCTION create_dedicated_vm_host (
create_dedicated_vm_host_details dbms_cloud_oci_core_create_dedicated_vm_host_details_t,
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_cr_compute_create_dedicated_vm_host_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The details for creating a new dedicated virtual machine host. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_IMAGE Function
Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service. When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and the OCID of the compartment containing that instance. For more information about images, see Managing Custom Images. When importing an exported image from Object Storage, you specify the source information in IMAGE_SOURCE_DETAILS Function. When importing an image based on the namespace, bucket name, and object name, use IMAGE_SOURCE_VIA_OBJECT_STORAGE_TUPLE_DETAILS Function. When importing an image based on the Object Storage URL, use IMAGE_SOURCE_VIA_OBJECT_STORAGE_URI_DETAILS Function. See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export. For more information about importing exported images, see Image Import/Export. You may optionally specify a *display name* for the image, which is simply a friendly name or description. It does not have to be unique, and you can change it. See UPDATE_IMAGE Function. Avoid entering confidential information.
Syntax
FUNCTION create_image (
create_image_details dbms_cloud_oci_core_create_image_details_t,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_create_image_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Image creation details |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
CREATE_INSTANCE_CONSOLE_CONNECTION Function
Creates a new console connection to the specified instance. After the console connection has been created and is available, you connect to the console using SSH. For more information about instance console connections, see Troubleshooting Instances Using Instance Console Connections.
Syntax
FUNCTION create_instance_console_connection (
create_instance_console_connection_details dbms_cloud_oci_core_create_instance_console_connection_details_t,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_create_instance_console_connection_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Request object for creating an InstanceConsoleConnection |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_APP_CATALOG_SUBSCRIPTION Function
Delete a subscription for a listing resource version for a compartment.
Syntax
FUNCTION delete_app_catalog_subscription (
listing_id varchar2,
compartment_id varchar2,
resource_version varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_delete_app_catalog_subscription_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the listing. |
|
|
(required) The OCID of the compartment. |
|
|
(required) Listing Resource Version. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_COMPUTE_CAPACITY_RESERVATION Function
Deletes the specified compute capacity reservation.
Syntax
FUNCTION delete_compute_capacity_reservation (
capacity_reservation_id varchar2,
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_cr_compute_delete_compute_capacity_reservation_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity reservation. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_COMPUTE_CAPACITY_TOPOLOGY Function
Deletes the specified compute capacity topology.
Syntax
FUNCTION delete_compute_capacity_topology (
compute_capacity_topology_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_cr_compute_delete_compute_capacity_topology_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity topology. |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_COMPUTE_CLUSTER Function
Deletes a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. Before you delete a compute cluster, first delete all instances in the cluster by using the TERMINATE_INSTANCE Function operation.
Syntax
FUNCTION delete_compute_cluster (
compute_cluster_id varchar2,
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_cr_compute_delete_compute_cluster_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_COMPUTE_IMAGE_CAPABILITY_SCHEMA Function
Deletes the specified Compute Image Capability Schema
Syntax
FUNCTION delete_compute_image_capability_schema (
compute_image_capability_schema_id varchar2,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_delete_compute_image_capability_schema_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The id of the compute image capability schema or the image ocid |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_CONSOLE_HISTORY Function
Deletes the specified console history metadata and the console history data.
Syntax
FUNCTION delete_console_history (
instance_console_history_id varchar2,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_delete_console_history_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the console history. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_DEDICATED_VM_HOST Function
Deletes the specified dedicated virtual machine host. If any VM instances are assigned to the dedicated virtual machine host, the delete operation will fail and the service will return a 409 response code.
Syntax
FUNCTION delete_dedicated_vm_host (
dedicated_vm_host_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_cr_compute_delete_dedicated_vm_host_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the dedicated VM host. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_IMAGE Function
Deletes an image.
Syntax
FUNCTION delete_image (
image_id varchar2,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_delete_image_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the image. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DELETE_INSTANCE_CONSOLE_CONNECTION Function
Deletes the specified instance console connection.
Syntax
FUNCTION delete_instance_console_connection (
instance_console_connection_id varchar2,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_delete_instance_console_connection_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance console connection. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DETACH_BOOT_VOLUME Function
Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment. This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed.
Syntax
FUNCTION detach_boot_volume (
boot_volume_attachment_id varchar2,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_detach_boot_volume_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the boot volume attachment. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DETACH_VNIC Function
Detaches and deletes the specified secondary VNIC. This operation cannot be used on the instance's primary VNIC. When you terminate an instance, all attached VNICs (primary and secondary) are automatically detached and deleted. **Important:** If the VNIC has a PRIVATE_IP Type that is the target of a route rule, deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.
Syntax
FUNCTION detach_vnic (
vnic_attachment_id varchar2,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_detach_vnic_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the VNIC attachment. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
DETACH_VOLUME Function
Detaches a storage volume from an instance. You must specify the OCID of the volume attachment. This is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily until the attachment is completely removed.
Syntax
FUNCTION detach_volume (
volume_attachment_id varchar2,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_detach_volume_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the volume attachment. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
EXPORT_IMAGE Function
Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL, or the namespace, bucket name, and object name when specifying the location to export to. For more information about exporting images, see Image Import/Export. To perform an image export, you need write access to the Object Storage bucket for the image, see Let Users Write Objects to Object Storage Buckets. See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export.
Syntax
FUNCTION export_image (
image_id varchar2,
export_image_details dbms_cloud_oci_core_export_image_details_t,
opc_retry_token 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_cr_compute_export_image_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the image. |
|
|
(required) Details for the image export. |
|
|
(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 may be rejected). |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_APP_CATALOG_LISTING Function
Gets the specified listing.
Syntax
FUNCTION get_app_catalog_listing (
listing_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_app_catalog_listing_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the listing. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_APP_CATALOG_LISTING_AGREEMENTS Function
Retrieves the agreements for a particular resource version of a listing.
Syntax
FUNCTION get_app_catalog_listing_agreements (
listing_id varchar2,
resource_version varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_app_catalog_listing_agreements_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the listing. |
|
|
(required) Listing Resource Version. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_APP_CATALOG_LISTING_RESOURCE_VERSION Function
Gets the specified listing resource version.
Syntax
FUNCTION get_app_catalog_listing_resource_version (
listing_id varchar2,
resource_version varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_app_catalog_listing_resource_version_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the listing. |
|
|
(required) Listing Resource Version. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_BOOT_VOLUME_ATTACHMENT Function
Gets information about the specified boot volume attachment.
Syntax
FUNCTION get_boot_volume_attachment (
boot_volume_attachment_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_boot_volume_attachment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the boot volume attachment. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_COMPUTE_CAPACITY_RESERVATION Function
Gets information about the specified compute capacity reservation.
Syntax
FUNCTION get_compute_capacity_reservation (
capacity_reservation_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_cr_compute_get_compute_capacity_reservation_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity reservation. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_COMPUTE_CAPACITY_TOPOLOGY Function
Gets information about the specified compute capacity topology.
Syntax
FUNCTION get_compute_capacity_topology (
compute_capacity_topology_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_cr_compute_get_compute_capacity_topology_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity topology. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_COMPUTE_CLUSTER Function
Gets information about a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group.
Syntax
FUNCTION get_compute_cluster (
compute_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_cr_compute_get_compute_cluster_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_COMPUTE_GLOBAL_IMAGE_CAPABILITY_SCHEMA Function
Gets the specified Compute Global Image Capability Schema
Syntax
FUNCTION get_compute_global_image_capability_schema (
compute_global_image_capability_schema_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_compute_global_image_capability_schema_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute global image capability schema |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_COMPUTE_GLOBAL_IMAGE_CAPABILITY_SCHEMA_VERSION Function
Gets the specified Compute Global Image Capability Schema Version
Syntax
FUNCTION get_compute_global_image_capability_schema_version (
compute_global_image_capability_schema_id varchar2,
compute_global_image_capability_schema_version_name varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_compute_global_image_capability_schema_version_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute global image capability schema |
|
|
(required) The name of the compute global image capability schema version |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_COMPUTE_IMAGE_CAPABILITY_SCHEMA Function
Gets the specified Compute Image Capability Schema
Syntax
FUNCTION get_compute_image_capability_schema (
compute_image_capability_schema_id varchar2,
is_merge_enabled number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_compute_image_capability_schema_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The id of the compute image capability schema or the image ocid |
|
|
(optional) Merge the image capability schema with the global image capability schema |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CONSOLE_HISTORY Function
Shows the metadata for the specified console history. See CAPTURE_CONSOLE_HISTORY Function for details about using the console history operations.
Syntax
FUNCTION get_console_history (
instance_console_history_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_console_history_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the console history. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_CONSOLE_HISTORY_CONTENT Function
Gets the actual console history data (not the metadata). See CAPTURE_CONSOLE_HISTORY Function for details about using the console history operations.
Syntax
FUNCTION get_console_history_content (
instance_console_history_id varchar2,
offset number DEFAULT NULL,
length number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_console_history_content_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the console history. |
|
|
(optional) Offset of the snapshot data to retrieve. |
|
|
(optional) Length of the snapshot data to retrieve. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_DEDICATED_VM_HOST Function
Gets information about the specified dedicated virtual machine host.
Syntax
FUNCTION get_dedicated_vm_host (
dedicated_vm_host_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_cr_compute_get_dedicated_vm_host_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the dedicated VM host. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_IMAGE Function
Gets the specified image.
Syntax
FUNCTION get_image (
image_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_image_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the image. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_IMAGE_SHAPE_COMPATIBILITY_ENTRY Function
Retrieves an image shape compatibility entry.
Syntax
FUNCTION get_image_shape_compatibility_entry (
image_id varchar2,
shape_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_cr_compute_get_image_shape_compatibility_entry_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the image. |
|
|
(required) Shape name. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_INSTANCE Function
Gets information about the specified instance. **Note:** To retrieve public and private IP addresses for an instance, use the LIST_VNIC_ATTACHMENTS Function operation to get the VNIC ID for the instance, and then call GET_VNIC Function with the VNIC ID.
Syntax
FUNCTION get_instance (
instance_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_instance_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_INSTANCE_CONSOLE_CONNECTION Function
Gets the specified instance console connection's information.
Syntax
FUNCTION get_instance_console_connection (
instance_console_connection_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_instance_console_connection_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance console connection. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_INSTANCE_MAINTENANCE_REBOOT Function
Gets the maximum possible date that a maintenance reboot can be extended. For more information, see Infrastructure Maintenance.
Syntax
FUNCTION get_instance_maintenance_reboot (
instance_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_cr_compute_get_instance_maintenance_reboot_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_MEASURED_BOOT_REPORT Function
Gets the measured boot report for this shielded instance.
Syntax
FUNCTION get_measured_boot_report (
instance_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_cr_compute_get_measured_boot_report_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_VNIC_ATTACHMENT Function
Gets the information for the specified VNIC attachment.
Syntax
FUNCTION get_vnic_attachment (
vnic_attachment_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_vnic_attachment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the VNIC attachment. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_VOLUME_ATTACHMENT Function
Gets information about the specified volume attachment.
Syntax
FUNCTION get_volume_attachment (
volume_attachment_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_volume_attachment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the volume attachment. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
GET_WINDOWS_INSTANCE_INITIAL_CREDENTIALS Function
Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows. For certain operating systems, users will be forced to change the initial credentials.
Syntax
FUNCTION get_windows_instance_initial_credentials (
instance_id varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_get_windows_instance_initial_credentials_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
INSTANCE_ACTION Function
Performs one of the following power actions on the specified instance: - **START** - Powers on the instance. - **STOP** - Powers off the instance. - **RESET** - Powers off the instance and then powers it back on. - **SOFTSTOP** - Gracefully shuts down the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off. If the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting in data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the instance. - **SOFTRESET** - Gracefully reboots the instance by sending a shutdown command to the operating system. After waiting 15 minutes for the OS to shut down, the instance is powered off and then powered back on. - **SENDDIAGNOSTICINTERRUPT** - For advanced users. **Caution: Sending a diagnostic interrupt to a live system can cause data corruption or system failure.** Sends a diagnostic interrupt that causes the instance's OS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a crash dump file when it crashes. The crash dump captures information about the state of the OS at the time of the crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see Sending a Diagnostic Interrupt. - **DIAGNOSTICREBOOT** - Powers off the instance, rebuilds it, and then powers it back on. Before you send a diagnostic reboot, restart the instance's OS, confirm that the instance and networking settings are configured correctly, and try other troubleshooting steps. Use diagnostic reboot as a final attempt to troubleshoot an unreachable instance. For virtual machine (VM) instances only. For more information, see Performing a Diagnostic Reboot. - **REBOOTMIGRATE** - Powers off the instance, moves it to new hardware, and then powers it back on. For more information, see Infrastructure Maintenance. For more information about managing instance lifecycle states, see Stopping and Starting an Instance.
Syntax
FUNCTION instance_action (
instance_id varchar2,
action varchar2,
opc_retry_token varchar2 DEFAULT NULL,
if_match varchar2 DEFAULT NULL,
instance_power_action_details dbms_cloud_oci_core_instance_power_action_details_t DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_instance_action_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(required) The action to perform on the instance. Allowed values are: 'STOP', 'START', 'SOFTRESET', 'RESET', 'SOFTSTOP', 'SENDDIAGNOSTICINTERRUPT', 'DIAGNOSTICREBOOT', 'REBOOTMIGRATE' |
|
|
(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 may be rejected). |
|
|
(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. |
|
|
(optional) Instance Power Action details |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LAUNCH_INSTANCE Function
Creates a new instance in the specified compartment and the specified availability domain. For general information about instances, see Overview of the Compute Service. For information about access control and compartments, see Overview of the IAM Service. For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the `ListAvailabilityDomains` operation in the Identity and Access Management Service API. All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. To launch an instance using an image or a boot volume use the `sourceDetails` parameter in LAUNCH_INSTANCE_DETAILS Type. When you launch an instance, it is automatically attached to a virtual network interface card (VNIC), called the *primary VNIC*. The VNIC has a private IP address from the subnet's CIDR. You can either assign a private IP address of your choice or let Oracle automatically assign one. You can choose whether the instance has a public IP address. To retrieve the addresses, use the LIST_VNIC_ATTACHMENTS Function operation to get the VNIC ID for the instance, and then call GET_VNIC Function with the VNIC ID. You can later add secondary VNICs to an instance. For more information, see Virtual Network Interface Cards (VNICs). To launch an instance from a Marketplace image listing, you must provide the image ID of the listing resource version that you want, but you also must subscribe to the listing before you try to launch the instance. To subscribe to the listing, use the GET_APP_CATALOG_LISTING_AGREEMENTS Function operation to get the signature for the terms of use agreement for the desired listing resource version. Then, call CREATE_APP_CATALOG_SUBSCRIPTION Function with the signature. To get the image ID for the LaunchInstance operation, call GET_APP_CATALOG_LISTING_RESOURCE_VERSION Function. To determine whether capacity is available for a specific shape before you create an instance, use the CREATE_COMPUTE_CAPACITY_REPORT Function operation.
Syntax
FUNCTION launch_instance (
launch_instance_details dbms_cloud_oci_core_launch_instance_details_t,
opc_retry_token varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_launch_instance_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) Instance details |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_APP_CATALOG_LISTING_RESOURCE_VERSIONS Function
Gets all resource versions for a particular listing.
Syntax
FUNCTION list_app_catalog_listing_resource_versions (
listing_id varchar2,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_app_catalog_listing_resource_versions_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the listing. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_APP_CATALOG_LISTINGS Function
Lists the published listings.
Syntax
FUNCTION list_app_catalog_listings (
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
publisher_name varchar2 DEFAULT NULL,
publisher_type 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_cr_compute_list_app_catalog_listings_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) A filter to return only the publisher that matches the given publisher name exactly. |
|
|
(optional) A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD. |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_APP_CATALOG_SUBSCRIPTIONS Function
Lists subscriptions for a compartment.
Syntax
FUNCTION list_app_catalog_subscriptions (
compartment_id varchar2,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
listing_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_app_catalog_subscriptions_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) A filter to return only the listings that matches the given listing id. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_BOOT_VOLUME_ATTACHMENTS Function
Lists the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.
Syntax
FUNCTION list_boot_volume_attachments (
availability_domain varchar2,
compartment_id varchar2,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
instance_id varchar2 DEFAULT NULL,
boot_volume_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_boot_volume_attachments_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(required) The OCID of the compartment. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The OCID of the instance. |
|
|
(optional) The OCID of the boot volume. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_CAPACITY_RESERVATION_INSTANCE_SHAPES Function
Lists the shapes that can be reserved within the specified compartment.
Syntax
FUNCTION list_compute_capacity_reservation_instance_shapes (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_capacity_reservation_instance_shapes_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_CAPACITY_RESERVATION_INSTANCES Function
Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.
Syntax
FUNCTION list_compute_capacity_reservation_instances (
capacity_reservation_id varchar2,
availability_domain varchar2 DEFAULT NULL,
compartment_id 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,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_capacity_reservation_instances_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity reservation. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) The OCID of the compartment. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_CAPACITY_RESERVATIONS Function
Lists the compute capacity reservations that match the specified criteria and compartment. You can limit the list by specifying a compute capacity reservation display name (the list will include all the identically-named compute capacity reservations in the compartment).
Syntax
FUNCTION list_compute_capacity_reservations (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_capacity_reservations_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) A filter to only return resources that match the given lifecycle state. |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_CAPACITY_TOPOLOGIES Function
Lists the compute capacity topologies in the specified compartment. You can filter the list by a compute capacity topology display name.
Syntax
FUNCTION list_compute_capacity_topologies (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_capacity_topologies_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_CAPACITY_TOPOLOGY_COMPUTE_BARE_METAL_HOSTS Function
Lists compute bare metal hosts in the specified compute capacity topology.
Syntax
FUNCTION list_compute_capacity_topology_compute_bare_metal_hosts (
compute_capacity_topology_id varchar2,
availability_domain varchar2 DEFAULT NULL,
compartment_id varchar2 DEFAULT NULL,
compute_hpc_island_id varchar2 DEFAULT NULL,
compute_network_block_id varchar2 DEFAULT NULL,
compute_local_block_id varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_capacity_topology_compute_bare_metal_hosts_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity topology. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) The OCID of the compartment. |
|
|
(optional) The OCID of the compute HPC island. |
|
|
(optional) The OCID of the compute network block. |
|
|
(optional) The OCID of the compute local block. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_CAPACITY_TOPOLOGY_COMPUTE_HPC_ISLANDS Function
Lists compute HPC islands in the specified compute capacity topology.
Syntax
FUNCTION list_compute_capacity_topology_compute_hpc_islands (
compute_capacity_topology_id varchar2,
availability_domain varchar2 DEFAULT NULL,
compartment_id varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_capacity_topology_compute_hpc_islands_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity topology. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) The OCID of the compartment. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_CAPACITY_TOPOLOGY_COMPUTE_NETWORK_BLOCKS Function
Lists compute network blocks in the specified compute capacity topology.
Syntax
FUNCTION list_compute_capacity_topology_compute_network_blocks (
compute_capacity_topology_id varchar2,
availability_domain varchar2 DEFAULT NULL,
compartment_id varchar2 DEFAULT NULL,
compute_hpc_island_id varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_capacity_topology_compute_network_blocks_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity topology. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) The OCID of the compartment. |
|
|
(optional) The OCID of the compute HPC island. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_CLUSTERS Function
Lists the compute clusters in the specified compartment. A compute cluster is a remote direct memory access (RDMA) network group.
Syntax
FUNCTION list_compute_clusters (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order 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_cr_compute_list_compute_clusters_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_GLOBAL_IMAGE_CAPABILITY_SCHEMA_VERSIONS Function
Lists Compute Global Image Capability Schema versions in the specified compartment.
Syntax
FUNCTION list_compute_global_image_capability_schema_versions (
compute_global_image_capability_schema_id varchar2,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_global_image_capability_schema_versions_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute global image capability schema |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_GLOBAL_IMAGE_CAPABILITY_SCHEMAS Function
Lists Compute Global Image Capability Schema in the specified compartment.
Syntax
FUNCTION list_compute_global_image_capability_schemas (
compartment_id varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_global_image_capability_schemas_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(optional) A filter to return only resources that match the given compartment OCID exactly. |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_COMPUTE_IMAGE_CAPABILITY_SCHEMAS Function
Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.
Syntax
FUNCTION list_compute_image_capability_schemas (
compartment_id varchar2 DEFAULT NULL,
image_id varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_compute_image_capability_schemas_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(optional) A filter to return only resources that match the given compartment OCID exactly. |
|
|
(optional) The OCID of an image. |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_CONSOLE_HISTORIES Function
Lists the console history metadata for the specified compartment or instance.
Syntax
FUNCTION list_console_histories (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
instance_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_console_histories_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The OCID of the instance. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_DEDICATED_VM_HOST_INSTANCE_SHAPES Function
Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment. You can filter the list by compatibility with a specific dedicated virtual machine host shape.
Syntax
FUNCTION list_dedicated_vm_host_instance_shapes (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
dedicated_vm_host_shape varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page 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_cr_compute_list_dedicated_vm_host_instance_shapes_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) Dedicated VM host shape name |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_DEDICATED_VM_HOST_INSTANCES Function
Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
Syntax
FUNCTION list_dedicated_vm_host_instances (
compartment_id varchar2,
dedicated_vm_host_id varchar2,
availability_domain varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_dedicated_vm_host_instances_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(required) The OCID of the dedicated VM host. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_DEDICATED_VM_HOST_SHAPES Function
Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
Syntax
FUNCTION list_dedicated_vm_host_shapes (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
instance_shape_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page 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_cr_compute_list_dedicated_vm_host_shapes_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) The name for the instance's shape. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_DEDICATED_VM_HOSTS Function
Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment. You can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named dedicated virtual machine hosts in the compartment.
Syntax
FUNCTION list_dedicated_vm_hosts (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
instance_shape_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
remaining_memory_in_g_bs_greater_than_or_equal_to number DEFAULT NULL,
remaining_ocpus_greater_than_or_equal_to number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_dedicated_vm_hosts_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) A filter to only return resources that match the given lifecycle state. Allowed values are: 'CREATING', 'ACTIVE', 'UPDATING', 'DELETING', 'DELETED', 'FAILED' |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) The name for the instance's shape. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) The remaining memory of the dedicated VM host, in GBs. |
|
|
(optional) The available OCPUs of the dedicated VM host. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_IMAGE_SHAPE_COMPATIBILITY_ENTRIES Function
Lists the compatible shapes for the specified image.
Syntax
FUNCTION list_image_shape_compatibility_entries (
image_id varchar2,
limit number DEFAULT NULL,
page 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_cr_compute_list_image_shape_compatibility_entries_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the image. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_IMAGES Function
Lists a subset of images available in the specified compartment, including platform images and custom images. The list of platform images includes the three most recently published versions of each major distribution. The list does not support filtering based on image tags. The list of images returned is ordered to first show the recent platform images, then all of the custom images. **Caution:** Platform images are refreshed regularly. When new images are released, older versions are replaced. The image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.
Syntax
FUNCTION list_images (
compartment_id varchar2,
display_name varchar2 DEFAULT NULL,
operating_system varchar2 DEFAULT NULL,
operating_system_version varchar2 DEFAULT NULL,
shape varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_images_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) The image's operating system. Example: `Oracle Linux` |
|
|
(optional) The image's operating system version. Example: `7.2` |
|
|
(optional) Shape name. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_INSTANCE_CONSOLE_CONNECTIONS Function
Lists the console connections for the specified compartment or instance. For more information about instance console connections, see Troubleshooting Instances Using Instance Console Connections.
Syntax
FUNCTION list_instance_console_connections (
compartment_id varchar2,
instance_id varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_instance_console_connections_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The OCID of the instance. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_INSTANCE_DEVICES Function
Gets a list of all the devices for given instance. You can optionally filter results by device availability.
Syntax
FUNCTION list_instance_devices (
instance_id varchar2,
is_available number DEFAULT NULL,
name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
opc_request_id varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_instance_devices_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(optional) A filter to return only available devices or only used devices. |
|
|
(optional) A filter to return only devices that match the given name exactly. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_INSTANCES Function
Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment). **Note:** To retrieve public and private IP addresses for an instance, use the LIST_VNIC_ATTACHMENTS Function operation to get the VNIC ID for the instance, and then call GET_VNIC Function with the VNIC ID.
Syntax
FUNCTION list_instances (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
capacity_reservation_id varchar2 DEFAULT NULL,
compute_cluster_id varchar2 DEFAULT NULL,
display_name varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
sort_by varchar2 DEFAULT NULL,
sort_order varchar2 DEFAULT NULL,
lifecycle_state varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_instances_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) The OCID of the compute capacity reservation. |
|
|
(optional) The OCID of the compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. |
|
|
(optional) A filter to return only resources that match the given display name exactly. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some \"List\" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these \"List\" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. Allowed values are: 'TIMECREATED', 'DISPLAYNAME' |
|
|
(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC' |
|
|
(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_SHAPES Function
Lists the shapes that can be used to launch an instance within the specified compartment. You can filter the list by compatibility with a specific image.
Syntax
FUNCTION list_shapes (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
image_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_shapes_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The OCID of an image. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_VNIC_ATTACHMENTS Function
Lists the VNIC attachments in the specified compartment. A VNIC attachment resides in the same compartment as the attached instance. The list can be filtered by instance, VNIC, or availability domain.
Syntax
FUNCTION list_vnic_attachments (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
instance_id varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
vnic_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_vnic_attachments_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) The OCID of the instance. |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The OCID of the VNIC. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
LIST_VOLUME_ATTACHMENTS Function
Lists the volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, volume OCID, or both. Currently, the only supported volume attachment type are I_SCSI_VOLUME_ATTACHMENT Type and PARAVIRTUALIZED_VOLUME_ATTACHMENT Type.
Syntax
FUNCTION list_volume_attachments (
compartment_id varchar2,
availability_domain varchar2 DEFAULT NULL,
limit number DEFAULT NULL,
page varchar2 DEFAULT NULL,
instance_id varchar2 DEFAULT NULL,
volume_id varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_list_volume_attachments_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compartment. |
|
|
(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1` |
|
|
(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50` |
|
|
(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. |
|
|
(optional) The OCID of the instance. |
|
|
(optional) The OCID of the volume. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
REMOVE_IMAGE_SHAPE_COMPATIBILITY_ENTRY Function
Removes a shape from the compatible shapes list for the image.
Syntax
FUNCTION remove_image_shape_compatibility_entry (
image_id varchar2,
shape_name varchar2,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_remove_image_shape_compatibility_entry_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the image. |
|
|
(required) Shape name. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
TERMINATE_INSTANCE Function
Permanently terminates (deletes) the specified instance. Any attached VNICs and volumes are automatically detached when the instance terminates. To preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`. To delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`. This is an asynchronous operation. The instance's `lifecycleState` changes to TERMINATING temporarily until the instance is completely deleted. After the instance is deleted, the record remains visible in the list of instances with the state TERMINATED for at least 12 hours, but no further action is needed.
Syntax
FUNCTION terminate_instance (
instance_id varchar2,
if_match varchar2 DEFAULT NULL,
preserve_boot_volume number DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_terminate_instance_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(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. |
|
|
(optional) Specifies whether to delete or preserve the boot volume when terminating an instance. When set to `true`, the boot volume is preserved. The default value is `false`. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_COMPUTE_CAPACITY_RESERVATION Function
Updates the specified capacity reservation and its associated capacity configurations. Fields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted. Avoid entering confidential information.
Syntax
FUNCTION update_compute_capacity_reservation (
capacity_reservation_id varchar2,
update_compute_capacity_reservation_details dbms_cloud_oci_core_update_compute_capacity_reservation_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_cr_compute_update_compute_capacity_reservation_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity reservation. |
|
|
(required) Update compute capacity reservation details. |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_COMPUTE_CAPACITY_TOPOLOGY Function
Updates the specified compute capacity topology. Fields that are not provided in the request will not be updated.
Syntax
FUNCTION update_compute_capacity_topology (
compute_capacity_topology_id varchar2,
update_compute_capacity_topology_details dbms_cloud_oci_core_update_compute_capacity_topology_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_cr_compute_update_compute_capacity_topology_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute capacity topology. |
|
|
(required) Update compute capacity topology details. |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_COMPUTE_CLUSTER Function
Updates a compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. To create instances within a compute cluster, use the LAUNCH_INSTANCE Function operation. To delete instances from a compute cluster, use the TERMINATE_INSTANCE Function operation.
Syntax
FUNCTION update_compute_cluster (
compute_cluster_id varchar2,
update_compute_cluster_details dbms_cloud_oci_core_update_compute_cluster_details_t,
opc_request_id varchar2 DEFAULT NULL,
opc_retry_token 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_cr_compute_update_compute_cluster_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the compute cluster. A compute cluster is a remote direct memory access (RDMA) network group. |
|
|
(required) Details for updating the compute cluster. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_COMPUTE_IMAGE_CAPABILITY_SCHEMA Function
Updates the specified Compute Image Capability Schema
Syntax
FUNCTION update_compute_image_capability_schema (
compute_image_capability_schema_id varchar2,
update_compute_image_capability_schema_details dbms_cloud_oci_core_update_compute_image_capability_schema_details_t,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_update_compute_image_capability_schema_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The id of the compute image capability schema or the image ocid |
|
|
(required) Updates the freeFormTags, definedTags, and display name of the image capability schema |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_CONSOLE_HISTORY Function
Updates the specified console history metadata.
Syntax
FUNCTION update_console_history (
instance_console_history_id varchar2,
update_console_history_details dbms_cloud_oci_core_update_console_history_details_t,
if_match varchar2 DEFAULT NULL,
region varchar2 DEFAULT NULL,
endpoint varchar2 DEFAULT NULL,
credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_compute_update_console_history_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the console history. |
|
|
(required) Update instance fields |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_DEDICATED_VM_HOST Function
Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host. If an attribute value is not included, it will not be updated.
Syntax
FUNCTION update_dedicated_vm_host (
dedicated_vm_host_id varchar2,
update_dedicated_vm_host_details dbms_cloud_oci_core_update_dedicated_vm_host_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_cr_compute_update_dedicated_vm_host_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the dedicated VM host. |
|
|
(required) Update dedicated VM host details |
|
|
(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. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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 may be rejected). |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_IMAGE Function
Updates the display name of the image. Avoid entering confidential information.
Syntax
FUNCTION update_image (
image_id varchar2,
update_image_details dbms_cloud_oci_core_update_image_details_t,
opc_retry_token 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_cr_compute_update_image_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the image. |
|
|
(required) Updates the image display name field. Avoid entering confidential information. |
|
|
(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 may be rejected). |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_INSTANCE Function
Updates certain fields on the specified instance. Fields that are not provided in the request will not be updated. Avoid entering confidential information. Changes to metadata fields will be reflected in the instance metadata service (this may take up to a minute). The OCID of the instance remains the same.
Syntax
FUNCTION update_instance (
instance_id varchar2,
update_instance_details dbms_cloud_oci_core_update_instance_details_t,
opc_retry_token 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_cr_compute_update_instance_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance. |
|
|
(required) Update instance fields |
|
|
(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 may be rejected). |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_INSTANCE_CONSOLE_CONNECTION Function
Updates the defined tags and free-form tags for the specified instance console connection.
Syntax
FUNCTION update_instance_console_connection (
instance_console_connection_id varchar2,
update_instance_console_connection_details dbms_cloud_oci_core_update_instance_console_connection_details_t,
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_cr_compute_update_instance_console_connection_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the instance console connection. |
|
|
(required) Update instanceConsoleConnection tags |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |
UPDATE_VOLUME_ATTACHMENT Function
Updates information about the specified volume attachment.
Syntax
FUNCTION update_volume_attachment (
volume_attachment_id varchar2,
update_volume_attachment_details dbms_cloud_oci_core_update_volume_attachment_details_t,
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_cr_compute_update_volume_attachment_response_t;Parameters
| Parameter | Description |
|---|---|
|
|
(required) The OCID of the volume attachment. |
|
|
(required) Update information about the specified volume attachment. |
|
|
(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. |
|
|
(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. |
|
|
(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix). |
|
|
(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence. |
|
|
(optional) The name of the credential for authenticating with the corresponding cloud native API. |