Class: OCI::Core::ComputeClient
- Inherits:
-
Object
- Object
- OCI::Core::ComputeClient
- Defined in:
- lib/oci/core/compute_client.rb
Overview
API covering the [Networking](/iaas/Content/Network/Concepts/overview.htm), [Compute](/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](/iaas/Content/Block/Concepts/overview.htm) services. Use this API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#add_image_shape_compatibility_entry(image_id, shape_name, opts = {}) ⇒ Response
Adds a shape to the compatible shapes list for the image.
-
#attach_boot_volume(attach_boot_volume_details, opts = {}) ⇒ Response
Attaches the specified boot volume to the specified instance.
-
#attach_vnic(attach_vnic_details, opts = {}) ⇒ Response
Creates a secondary VNIC and attaches it to the specified instance.
-
#attach_volume(attach_volume_details, opts = {}) ⇒ Response
Attaches the specified storage volume to the specified instance.
-
#capture_console_history(capture_console_history_details, opts = {}) ⇒ Response
Captures the most recent serial console data (up to a megabyte) for the specified instance.
-
#change_compute_image_capability_schema_compartment(compute_image_capability_schema_id, change_compute_image_capability_schema_compartment_details, opts = {}) ⇒ Response
Moves a compute image capability schema into a different compartment within the same tenancy.
-
#change_dedicated_vm_host_compartment(dedicated_vm_host_id, change_dedicated_vm_host_compartment_details, opts = {}) ⇒ Response
Moves a dedicated virtual machine host from one compartment to another.
-
#change_image_compartment(image_id, change_image_compartment_details, opts = {}) ⇒ Response
Moves an image into a different compartment within the same tenancy.
-
#change_instance_compartment(instance_id, change_instance_compartment_details, opts = {}) ⇒ Response
Moves an instance into a different compartment within the same tenancy.
-
#create_app_catalog_subscription(create_app_catalog_subscription_details, opts = {}) ⇒ Response
Create a subscription for listing resource version for a compartment.
-
#create_compute_image_capability_schema(create_compute_image_capability_schema_details, opts = {}) ⇒ Response
Creates compute image capability schema.
-
#create_dedicated_vm_host(create_dedicated_vm_host_details, opts = {}) ⇒ Response
Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.
-
#create_image(create_image_details, opts = {}) ⇒ Response
Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.
-
#create_instance_console_connection(create_instance_console_connection_details, opts = {}) ⇒ Response
Creates a new console connection to the specified instance.
-
#delete_app_catalog_subscription(listing_id, compartment_id, resource_version, opts = {}) ⇒ Response
Delete a subscription for a listing resource version for a compartment.
-
#delete_compute_image_capability_schema(compute_image_capability_schema_id, opts = {}) ⇒ Response
Deletes the specified Compute Image Capability Schema.
-
#delete_console_history(instance_console_history_id, opts = {}) ⇒ Response
Deletes the specified console history metadata and the console history data.
-
#delete_dedicated_vm_host(dedicated_vm_host_id, opts = {}) ⇒ Response
Deletes the specified dedicated virtual machine host.
-
#delete_image(image_id, opts = {}) ⇒ Response
Deletes an image.
-
#delete_instance_console_connection(instance_console_connection_id, opts = {}) ⇒ Response
Deletes the specified instance console connection.
-
#detach_boot_volume(boot_volume_attachment_id, opts = {}) ⇒ Response
Detaches a boot volume from an instance.
-
#detach_vnic(vnic_attachment_id, opts = {}) ⇒ Response
Detaches and deletes the specified secondary VNIC.
-
#detach_volume(volume_attachment_id, opts = {}) ⇒ Response
Detaches a storage volume from an instance.
-
#export_image(image_id, export_image_details, opts = {}) ⇒ Response
Exports the specified image to the Oracle Cloud Infrastructure Object Storage service.
-
#get_app_catalog_listing(listing_id, opts = {}) ⇒ Response
Gets the specified listing.
-
#get_app_catalog_listing_agreements(listing_id, resource_version, opts = {}) ⇒ Response
Retrieves the agreements for a particular resource version of a listing.
-
#get_app_catalog_listing_resource_version(listing_id, resource_version, opts = {}) ⇒ Response
Gets the specified listing resource version.
-
#get_boot_volume_attachment(boot_volume_attachment_id, opts = {}) ⇒ Response
Gets information about the specified boot volume attachment.
-
#get_compute_global_image_capability_schema(compute_global_image_capability_schema_id, opts = {}) ⇒ Response
Gets the specified Compute Global Image Capability Schema.
-
#get_compute_global_image_capability_schema_version(compute_global_image_capability_schema_id, compute_global_image_capability_schema_version_name, opts = {}) ⇒ Response
Gets the specified Compute Global Image Capability Schema Version.
-
#get_compute_image_capability_schema(compute_image_capability_schema_id, opts = {}) ⇒ Response
Gets the specified Compute Image Capability Schema.
-
#get_console_history(instance_console_history_id, opts = {}) ⇒ Response
Shows the metadata for the specified console history.
-
#get_console_history_content(instance_console_history_id, opts = {}) ⇒ Response
Gets the actual console history data (not the metadata).
-
#get_dedicated_vm_host(dedicated_vm_host_id, opts = {}) ⇒ Response
Gets information about the specified dedicated virtual machine host.
-
#get_image(image_id, opts = {}) ⇒ Response
Gets the specified image.
-
#get_image_shape_compatibility_entry(image_id, shape_name, opts = {}) ⇒ Response
Retrieves an image shape compatibility entry.
-
#get_instance(instance_id, opts = {}) ⇒ Response
Gets information about the specified instance.
-
#get_instance_console_connection(instance_console_connection_id, opts = {}) ⇒ Response
Gets the specified instance console connection’s information.
-
#get_vnic_attachment(vnic_attachment_id, opts = {}) ⇒ Response
Gets the information for the specified VNIC attachment.
-
#get_volume_attachment(volume_attachment_id, opts = {}) ⇒ Response
Gets information about the specified volume attachment.
-
#get_windows_instance_initial_credentials(instance_id, opts = {}) ⇒ Response
Gets the generated credentials for the instance.
-
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ComputeClient
constructor
Creates a new ComputeClient.
-
#instance_action(instance_id, action, opts = {}) ⇒ Response
Performs one of the following power actions on the specified instance:.
-
#launch_instance(launch_instance_details, opts = {}) ⇒ Response
Creates a new instance in the specified compartment and the specified availability domain.
-
#list_app_catalog_listing_resource_versions(listing_id, opts = {}) ⇒ Response
Gets all resource versions for a particular listing.
-
#list_app_catalog_listings(opts = {}) ⇒ Response
Lists the published listings.
-
#list_app_catalog_subscriptions(compartment_id, opts = {}) ⇒ Response
Lists subscriptions for a compartment.
-
#list_boot_volume_attachments(availability_domain, compartment_id, opts = {}) ⇒ Response
Lists the boot volume attachments in the specified compartment.
-
#list_compute_global_image_capability_schema_versions(compute_global_image_capability_schema_id, opts = {}) ⇒ Response
Lists Compute Global Image Capability Schema versions in the specified compartment.
-
#list_compute_global_image_capability_schemas(opts = {}) ⇒ Response
Lists Compute Global Image Capability Schema in the specified compartment.
-
#list_compute_image_capability_schemas(opts = {}) ⇒ Response
Lists Compute Image Capability Schema in the specified compartment.
-
#list_console_histories(compartment_id, opts = {}) ⇒ Response
Lists the console history metadata for the specified compartment or instance.
-
#list_dedicated_vm_host_instance_shapes(compartment_id, opts = {}) ⇒ Response
Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.
-
#list_dedicated_vm_host_instances(compartment_id, dedicated_vm_host_id, opts = {}) ⇒ Response
Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
-
#list_dedicated_vm_host_shapes(compartment_id, opts = {}) ⇒ Response
Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
-
#list_dedicated_vm_hosts(compartment_id, opts = {}) ⇒ Response
Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.
-
#list_image_shape_compatibility_entries(image_id, opts = {}) ⇒ Response
Lists the compatible shapes for the specified image.
-
#list_images(compartment_id, opts = {}) ⇒ Response
Lists the available images in the specified compartment, including both [Oracle-provided images](docs.cloud.oracle.com/Content/Compute/References/images.htm) and [custom images](docs.cloud.oracle.com/Content/Compute/Tasks/managingcustomimages.htm) that have been created.
-
#list_instance_console_connections(compartment_id, opts = {}) ⇒ Response
Lists the console connections for the specified compartment or instance.
-
#list_instance_devices(instance_id, opts = {}) ⇒ Response
Gets a list of all the devices for given instance.
-
#list_instances(compartment_id, opts = {}) ⇒ Response
Lists the instances in the specified compartment and the specified availability domain.
-
#list_shapes(compartment_id, opts = {}) ⇒ Response
Lists the shapes that can be used to launch an instance within the specified compartment.
-
#list_vnic_attachments(compartment_id, opts = {}) ⇒ Response
Lists the VNIC attachments in the specified compartment.
-
#list_volume_attachments(compartment_id, opts = {}) ⇒ Response
Lists the volume attachments in the specified compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#remove_image_shape_compatibility_entry(image_id, shape_name, opts = {}) ⇒ Response
Removes a shape from the compatible shapes list for the image.
-
#terminate_instance(instance_id, opts = {}) ⇒ Response
Terminates the specified instance.
-
#update_compute_image_capability_schema(compute_image_capability_schema_id, update_compute_image_capability_schema_details, opts = {}) ⇒ Response
Updates the specified Compute Image Capability Schema.
-
#update_console_history(instance_console_history_id, update_console_history_details, opts = {}) ⇒ Response
Updates the specified console history metadata.
-
#update_dedicated_vm_host(dedicated_vm_host_id, update_dedicated_vm_host_details, opts = {}) ⇒ Response
Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.
-
#update_image(image_id, update_image_details, opts = {}) ⇒ Response
Updates the display name of the image.
-
#update_instance(instance_id, update_instance_details, opts = {}) ⇒ Response
Updates certain fields on the specified instance.
-
#update_instance_console_connection(instance_console_connection_id, update_instance_console_connection_details, opts = {}) ⇒ Response
Updates the defined tags and free-form tags for the specified instance console connection.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ComputeClient
Creates a new ComputeClient. Notes:
If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the
region. A region may be specified in the config or via or the region parameter. If specified in both, then the
region parameter will be used.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/oci/core/compute_client.rb', line 57 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20160918' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "ComputeClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
17 18 19 |
# File 'lib/oci/core/compute_client.rb', line 17 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
21 22 23 |
# File 'lib/oci/core/compute_client.rb', line 21 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
31 32 33 |
# File 'lib/oci/core/compute_client.rb', line 31 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is ‘nil`, which means that an operation will not perform any retries
27 28 29 |
# File 'lib/oci/core/compute_client.rb', line 27 def retry_config @retry_config end |
Instance Method Details
#add_image_shape_compatibility_entry(image_id, shape_name, opts = {}) ⇒ Response
Adds a shape to the compatible shapes list for the image.
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'lib/oci/core/compute_client.rb', line 113 def add_image_shape_compatibility_entry(image_id, shape_name, opts = {}) logger.debug 'Calling operation ComputeClient#add_image_shape_compatibility_entry.' if logger raise "Missing the required parameter 'image_id' when calling add_image_shape_compatibility_entry." if image_id.nil? raise "Missing the required parameter 'shape_name' when calling add_image_shape_compatibility_entry." if shape_name.nil? raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id) raise "Parameter value for 'shape_name' must not be blank" if OCI::Internal::Util.blank_string?(shape_name) path = '/images/{imageId}/shapes/{shapeName}'.sub('{imageId}', image_id.to_s).sub('{shapeName}', shape_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(opts[:add_image_shape_compatibility_entry_details]) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#add_image_shape_compatibility_entry') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ImageShapeCompatibilityEntry' ) end # rubocop:enable Metrics/BlockLength end |
#attach_boot_volume(attach_boot_volume_details, opts = {}) ⇒ Response
Attaches the specified boot volume to the specified instance.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/oci/core/compute_client.rb', line 173 def attach_boot_volume(attach_boot_volume_details, opts = {}) logger.debug 'Calling operation ComputeClient#attach_boot_volume.' if logger raise "Missing the required parameter 'attach_boot_volume_details' when calling attach_boot_volume." if attach_boot_volume_details.nil? path = '/bootVolumeAttachments/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(attach_boot_volume_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#attach_boot_volume') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::BootVolumeAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#attach_vnic(attach_vnic_details, opts = {}) ⇒ Response
Creates a secondary VNIC and attaches it to the specified instance. For more information about secondary VNICs, see [Virtual Network Interface Cards (VNICs)](docs.cloud.oracle.com/Content/Network/Tasks/managingVNICs.htm).
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/oci/core/compute_client.rb', line 234 def attach_vnic(attach_vnic_details, opts = {}) logger.debug 'Calling operation ComputeClient#attach_vnic.' if logger raise "Missing the required parameter 'attach_vnic_details' when calling attach_vnic." if attach_vnic_details.nil? path = '/vnicAttachments/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(attach_vnic_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#attach_vnic') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::VnicAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#attach_volume(attach_volume_details, opts = {}) ⇒ Response
Attaches the specified storage volume to the specified instance.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 |
# File 'lib/oci/core/compute_client.rb', line 293 def attach_volume(attach_volume_details, opts = {}) logger.debug 'Calling operation ComputeClient#attach_volume.' if logger raise "Missing the required parameter 'attach_volume_details' when calling attach_volume." if attach_volume_details.nil? path = '/volumeAttachments/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(attach_volume_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#attach_volume') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::VolumeAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#capture_console_history(capture_console_history_details, opts = {}) ⇒ Response
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.
-
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.
-
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).
-
Use ‘GetConsoleHistoryContent` to get the actual console history data (not the
metadata).
-
Optionally, use ‘DeleteConsoleHistory` to delete the console history metadata
and the console history data.
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/oci/core/compute_client.rb', line 368 def capture_console_history(capture_console_history_details, opts = {}) logger.debug 'Calling operation ComputeClient#capture_console_history.' if logger raise "Missing the required parameter 'capture_console_history_details' when calling capture_console_history." if capture_console_history_details.nil? path = '/instanceConsoleHistories/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(capture_console_history_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#capture_console_history') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ConsoleHistory' ) end # rubocop:enable Metrics/BlockLength end |
#change_compute_image_capability_schema_compartment(compute_image_capability_schema_id, change_compute_image_capability_schema_compartment_details, opts = {}) ⇒ Response
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](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 |
# File 'lib/oci/core/compute_client.rb', line 437 def change_compute_image_capability_schema_compartment(compute_image_capability_schema_id, change_compute_image_capability_schema_compartment_details, opts = {}) logger.debug 'Calling operation ComputeClient#change_compute_image_capability_schema_compartment.' if logger raise "Missing the required parameter 'compute_image_capability_schema_id' when calling change_compute_image_capability_schema_compartment." if compute_image_capability_schema_id.nil? raise "Missing the required parameter 'change_compute_image_capability_schema_compartment_details' when calling change_compute_image_capability_schema_compartment." if change_compute_image_capability_schema_compartment_details.nil? raise "Parameter value for 'compute_image_capability_schema_id' must not be blank" if OCI::Internal::Util.blank_string?(compute_image_capability_schema_id) path = '/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}/actions/changeCompartment'.sub('{computeImageCapabilitySchemaId}', compute_image_capability_schema_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_compute_image_capability_schema_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#change_compute_image_capability_schema_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_dedicated_vm_host_compartment(dedicated_vm_host_id, change_dedicated_vm_host_compartment_details, opts = {}) ⇒ Response
Moves a dedicated virtual machine host from one compartment to another.
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 |
# File 'lib/oci/core/compute_client.rb', line 506 def change_dedicated_vm_host_compartment(dedicated_vm_host_id, change_dedicated_vm_host_compartment_details, opts = {}) logger.debug 'Calling operation ComputeClient#change_dedicated_vm_host_compartment.' if logger raise "Missing the required parameter 'dedicated_vm_host_id' when calling change_dedicated_vm_host_compartment." if dedicated_vm_host_id.nil? raise "Missing the required parameter 'change_dedicated_vm_host_compartment_details' when calling change_dedicated_vm_host_compartment." if change_dedicated_vm_host_compartment_details.nil? raise "Parameter value for 'dedicated_vm_host_id' must not be blank" if OCI::Internal::Util.blank_string?(dedicated_vm_host_id) path = '/dedicatedVmHosts/{dedicatedVmHostId}/actions/changeCompartment'.sub('{dedicatedVmHostId}', dedicated_vm_host_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_dedicated_vm_host_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#change_dedicated_vm_host_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_image_compartment(image_id, change_image_compartment_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/oci/core/compute_client.rb', line 578 def change_image_compartment(image_id, change_image_compartment_details, opts = {}) logger.debug 'Calling operation ComputeClient#change_image_compartment.' if logger raise "Missing the required parameter 'image_id' when calling change_image_compartment." if image_id.nil? raise "Missing the required parameter 'change_image_compartment_details' when calling change_image_compartment." if change_image_compartment_details.nil? raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id) path = '/images/{imageId}/actions/changeCompartment'.sub('{imageId}', image_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_image_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#change_image_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_instance_compartment(instance_id, change_instance_compartment_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
When you move an instance to a different compartment, associated resources such as boot volumes and VNICs are not moved.
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 |
# File 'lib/oci/core/compute_client.rb', line 653 def change_instance_compartment(instance_id, change_instance_compartment_details, opts = {}) logger.debug 'Calling operation ComputeClient#change_instance_compartment.' if logger raise "Missing the required parameter 'instance_id' when calling change_instance_compartment." if instance_id.nil? raise "Missing the required parameter 'change_instance_compartment_details' when calling change_instance_compartment." if change_instance_compartment_details.nil? raise "Parameter value for 'instance_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_id) path = '/instances/{instanceId}/actions/changeCompartment'.sub('{instanceId}', instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_instance_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#change_instance_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_app_catalog_subscription(create_app_catalog_subscription_details, opts = {}) ⇒ Response
Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 |
# File 'lib/oci/core/compute_client.rb', line 715 def create_app_catalog_subscription(create_app_catalog_subscription_details, opts = {}) logger.debug 'Calling operation ComputeClient#create_app_catalog_subscription.' if logger raise "Missing the required parameter 'create_app_catalog_subscription_details' when calling create_app_catalog_subscription." if create_app_catalog_subscription_details.nil? path = '/appCatalogSubscriptions' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_app_catalog_subscription_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#create_app_catalog_subscription') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::AppCatalogSubscription' ) end # rubocop:enable Metrics/BlockLength end |
#create_compute_image_capability_schema(create_compute_image_capability_schema_details, opts = {}) ⇒ Response
Creates compute image capability schema.
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 |
# File 'lib/oci/core/compute_client.rb', line 774 def create_compute_image_capability_schema(create_compute_image_capability_schema_details, opts = {}) logger.debug 'Calling operation ComputeClient#create_compute_image_capability_schema.' if logger raise "Missing the required parameter 'create_compute_image_capability_schema_details' when calling create_compute_image_capability_schema." if create_compute_image_capability_schema_details.nil? path = '/computeImageCapabilitySchemas' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_compute_image_capability_schema_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#create_compute_image_capability_schema') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ComputeImageCapabilitySchema' ) end # rubocop:enable Metrics/BlockLength end |
#create_dedicated_vm_host(create_dedicated_vm_host_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm).
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 |
# File 'lib/oci/core/compute_client.rb', line 839 def create_dedicated_vm_host(create_dedicated_vm_host_details, opts = {}) logger.debug 'Calling operation ComputeClient#create_dedicated_vm_host.' if logger raise "Missing the required parameter 'create_dedicated_vm_host_details' when calling create_dedicated_vm_host." if create_dedicated_vm_host_details.nil? path = '/dedicatedVmHosts' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_dedicated_vm_host_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#create_dedicated_vm_host') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DedicatedVmHost' ) end # rubocop:enable Metrics/BlockLength end |
#create_image(create_image_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/Compute/Tasks/managingcustomimages.htm).
When importing an exported image from Object Storage, you specify the source information in image_source_details.
When importing an image based on the namespace, bucket name, and object name, use image_source_via_object_storage_tuple_details.
When importing an image based on the Object Storage URL, use image_source_via_object_storage_uri_details. See [Object Storage URLs](docs.cloud.oracle.com/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](docs.cloud.oracle.com/Content/Object/Tasks/usingpreauthenticatedrequests.htm) for constructing URLs for image import/export.
For more information about importing exported images, see [Image Import/Export](docs.cloud.oracle.com/Content/Compute/Tasks/imageimportexport.htm).
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. Avoid entering confidential information.
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 |
# File 'lib/oci/core/compute_client.rb', line 921 def create_image(create_image_details, opts = {}) logger.debug 'Calling operation ComputeClient#create_image.' if logger raise "Missing the required parameter 'create_image_details' when calling create_image." if create_image_details.nil? path = '/images' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_image_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#create_image') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Image' ) end # rubocop:enable Metrics/BlockLength end |
#create_instance_console_connection(create_instance_console_connection_details, opts = {}) ⇒ Response
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 console access, see [Accessing the Console](docs.cloud.oracle.com/Content/Compute/References/serialconsole.htm).
984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 |
# File 'lib/oci/core/compute_client.rb', line 984 def create_instance_console_connection(create_instance_console_connection_details, opts = {}) logger.debug 'Calling operation ComputeClient#create_instance_console_connection.' if logger raise "Missing the required parameter 'create_instance_console_connection_details' when calling create_instance_console_connection." if create_instance_console_connection_details.nil? path = '/instanceConsoleConnections' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_instance_console_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#create_instance_console_connection') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::InstanceConsoleConnection' ) end # rubocop:enable Metrics/BlockLength end |
#delete_app_catalog_subscription(listing_id, compartment_id, resource_version, opts = {}) ⇒ Response
Delete a subscription for a listing resource version for a compartment.
1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 |
# File 'lib/oci/core/compute_client.rb', line 1039 def delete_app_catalog_subscription(listing_id, compartment_id, resource_version, opts = {}) logger.debug 'Calling operation ComputeClient#delete_app_catalog_subscription.' if logger raise "Missing the required parameter 'listing_id' when calling delete_app_catalog_subscription." if listing_id.nil? raise "Missing the required parameter 'compartment_id' when calling delete_app_catalog_subscription." if compartment_id.nil? raise "Missing the required parameter 'resource_version' when calling delete_app_catalog_subscription." if resource_version.nil? path = '/appCatalogSubscriptions' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:listingId] = listing_id query_params[:compartmentId] = compartment_id query_params[:resourceVersion] = resource_version # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#delete_app_catalog_subscription') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_compute_image_capability_schema(compute_image_capability_schema_id, opts = {}) ⇒ Response
Deletes the specified Compute Image Capability Schema
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 |
# File 'lib/oci/core/compute_client.rb', line 1099 def delete_compute_image_capability_schema(compute_image_capability_schema_id, opts = {}) logger.debug 'Calling operation ComputeClient#delete_compute_image_capability_schema.' if logger raise "Missing the required parameter 'compute_image_capability_schema_id' when calling delete_compute_image_capability_schema." if compute_image_capability_schema_id.nil? raise "Parameter value for 'compute_image_capability_schema_id' must not be blank" if OCI::Internal::Util.blank_string?(compute_image_capability_schema_id) path = '/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}'.sub('{computeImageCapabilitySchemaId}', compute_image_capability_schema_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#delete_compute_image_capability_schema') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_console_history(instance_console_history_id, opts = {}) ⇒ Response
Deletes the specified console history metadata and the console history data.
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 |
# File 'lib/oci/core/compute_client.rb', line 1154 def delete_console_history(instance_console_history_id, opts = {}) logger.debug 'Calling operation ComputeClient#delete_console_history.' if logger raise "Missing the required parameter 'instance_console_history_id' when calling delete_console_history." if instance_console_history_id.nil? raise "Parameter value for 'instance_console_history_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_console_history_id) path = '/instanceConsoleHistories/{instanceConsoleHistoryId}'.sub('{instanceConsoleHistoryId}', instance_console_history_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#delete_console_history') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_dedicated_vm_host(dedicated_vm_host_id, opts = {}) ⇒ Response
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.
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 |
# File 'lib/oci/core/compute_client.rb', line 1212 def delete_dedicated_vm_host(dedicated_vm_host_id, opts = {}) logger.debug 'Calling operation ComputeClient#delete_dedicated_vm_host.' if logger raise "Missing the required parameter 'dedicated_vm_host_id' when calling delete_dedicated_vm_host." if dedicated_vm_host_id.nil? raise "Parameter value for 'dedicated_vm_host_id' must not be blank" if OCI::Internal::Util.blank_string?(dedicated_vm_host_id) path = '/dedicatedVmHosts/{dedicatedVmHostId}'.sub('{dedicatedVmHostId}', dedicated_vm_host_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#delete_dedicated_vm_host') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_image(image_id, opts = {}) ⇒ Response
Deletes an image.
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 |
# File 'lib/oci/core/compute_client.rb', line 1267 def delete_image(image_id, opts = {}) logger.debug 'Calling operation ComputeClient#delete_image.' if logger raise "Missing the required parameter 'image_id' when calling delete_image." if image_id.nil? raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id) path = '/images/{imageId}'.sub('{imageId}', image_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#delete_image') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_instance_console_connection(instance_console_connection_id, opts = {}) ⇒ Response
Deletes the specified instance console connection.
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 |
# File 'lib/oci/core/compute_client.rb', line 1322 def delete_instance_console_connection(instance_console_connection_id, opts = {}) logger.debug 'Calling operation ComputeClient#delete_instance_console_connection.' if logger raise "Missing the required parameter 'instance_console_connection_id' when calling delete_instance_console_connection." if instance_console_connection_id.nil? raise "Parameter value for 'instance_console_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_console_connection_id) path = '/instanceConsoleConnections/{instanceConsoleConnectionId}'.sub('{instanceConsoleConnectionId}', instance_console_connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#delete_instance_console_connection') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#detach_boot_volume(boot_volume_attachment_id, opts = {}) ⇒ Response
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.
1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 |
# File 'lib/oci/core/compute_client.rb', line 1381 def detach_boot_volume(, opts = {}) logger.debug 'Calling operation ComputeClient#detach_boot_volume.' if logger raise "Missing the required parameter 'boot_volume_attachment_id' when calling detach_boot_volume." if .nil? raise "Parameter value for 'boot_volume_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/bootVolumeAttachments/{bootVolumeAttachmentId}'.sub('{bootVolumeAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#detach_boot_volume') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#detach_vnic(vnic_attachment_id, opts = {}) ⇒ Response
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 PrivateIp that is the [target of a route rule](docs.cloud.oracle.com/Content/Network/Tasks/managingroutetables.htm#privateip), deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 |
# File 'lib/oci/core/compute_client.rb', line 1446 def detach_vnic(, opts = {}) logger.debug 'Calling operation ComputeClient#detach_vnic.' if logger raise "Missing the required parameter 'vnic_attachment_id' when calling detach_vnic." if .nil? raise "Parameter value for 'vnic_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/vnicAttachments/{vnicAttachmentId}'.sub('{vnicAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#detach_vnic') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#detach_volume(volume_attachment_id, opts = {}) ⇒ Response
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.
1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 |
# File 'lib/oci/core/compute_client.rb', line 1505 def detach_volume(, opts = {}) logger.debug 'Calling operation ComputeClient#detach_volume.' if logger raise "Missing the required parameter 'volume_attachment_id' when calling detach_volume." if .nil? raise "Parameter value for 'volume_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/volumeAttachments/{volumeAttachmentId}'.sub('{volumeAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#detach_volume') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#export_image(image_id, export_image_details, opts = {}) ⇒ Response
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](docs.cloud.oracle.com/Content/Compute/Tasks/imageimportexport.htm).
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](docs.cloud.oracle.com/Content/Identity/Concepts/commonpolicies.htm#Let4).
See [Object Storage URLs](docs.cloud.oracle.com/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](docs.cloud.oracle.com/Content/Object/Tasks/usingpreauthenticatedrequests.htm) for constructing URLs for image import/export.
1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 |
# File 'lib/oci/core/compute_client.rb', line 1577 def export_image(image_id, export_image_details, opts = {}) logger.debug 'Calling operation ComputeClient#export_image.' if logger raise "Missing the required parameter 'image_id' when calling export_image." if image_id.nil? raise "Missing the required parameter 'export_image_details' when calling export_image." if export_image_details.nil? raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id) path = '/images/{imageId}/actions/export'.sub('{imageId}', image_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(export_image_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#export_image') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Image' ) end # rubocop:enable Metrics/BlockLength end |
#get_app_catalog_listing(listing_id, opts = {}) ⇒ Response
Gets the specified listing.
1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 |
# File 'lib/oci/core/compute_client.rb', line 1633 def get_app_catalog_listing(listing_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_app_catalog_listing.' if logger raise "Missing the required parameter 'listing_id' when calling get_app_catalog_listing." if listing_id.nil? raise "Parameter value for 'listing_id' must not be blank" if OCI::Internal::Util.blank_string?(listing_id) path = '/appCatalogListings/{listingId}'.sub('{listingId}', listing_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_app_catalog_listing') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::AppCatalogListing' ) end # rubocop:enable Metrics/BlockLength end |
#get_app_catalog_listing_agreements(listing_id, resource_version, opts = {}) ⇒ Response
Retrieves the agreements for a particular resource version of a listing.
1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 |
# File 'lib/oci/core/compute_client.rb', line 1687 def get_app_catalog_listing_agreements(listing_id, resource_version, opts = {}) logger.debug 'Calling operation ComputeClient#get_app_catalog_listing_agreements.' if logger raise "Missing the required parameter 'listing_id' when calling get_app_catalog_listing_agreements." if listing_id.nil? raise "Missing the required parameter 'resource_version' when calling get_app_catalog_listing_agreements." if resource_version.nil? raise "Parameter value for 'listing_id' must not be blank" if OCI::Internal::Util.blank_string?(listing_id) raise "Parameter value for 'resource_version' must not be blank" if OCI::Internal::Util.blank_string?(resource_version) path = '/appCatalogListings/{listingId}/resourceVersions/{resourceVersion}/agreements'.sub('{listingId}', listing_id.to_s).sub('{resourceVersion}', resource_version.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_app_catalog_listing_agreements') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::AppCatalogListingResourceVersionAgreements' ) end # rubocop:enable Metrics/BlockLength end |
#get_app_catalog_listing_resource_version(listing_id, resource_version, opts = {}) ⇒ Response
Gets the specified listing resource version.
1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 |
# File 'lib/oci/core/compute_client.rb', line 1743 def get_app_catalog_listing_resource_version(listing_id, resource_version, opts = {}) logger.debug 'Calling operation ComputeClient#get_app_catalog_listing_resource_version.' if logger raise "Missing the required parameter 'listing_id' when calling get_app_catalog_listing_resource_version." if listing_id.nil? raise "Missing the required parameter 'resource_version' when calling get_app_catalog_listing_resource_version." if resource_version.nil? raise "Parameter value for 'listing_id' must not be blank" if OCI::Internal::Util.blank_string?(listing_id) raise "Parameter value for 'resource_version' must not be blank" if OCI::Internal::Util.blank_string?(resource_version) path = '/appCatalogListings/{listingId}/resourceVersions/{resourceVersion}'.sub('{listingId}', listing_id.to_s).sub('{resourceVersion}', resource_version.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_app_catalog_listing_resource_version') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::AppCatalogListingResourceVersion' ) end # rubocop:enable Metrics/BlockLength end |
#get_boot_volume_attachment(boot_volume_attachment_id, opts = {}) ⇒ Response
Gets information about the specified boot volume attachment.
1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 |
# File 'lib/oci/core/compute_client.rb', line 1798 def (, opts = {}) logger.debug 'Calling operation ComputeClient#get_boot_volume_attachment.' if logger raise "Missing the required parameter 'boot_volume_attachment_id' when calling get_boot_volume_attachment." if .nil? raise "Parameter value for 'boot_volume_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/bootVolumeAttachments/{bootVolumeAttachmentId}'.sub('{bootVolumeAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_boot_volume_attachment') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::BootVolumeAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#get_compute_global_image_capability_schema(compute_global_image_capability_schema_id, opts = {}) ⇒ Response
Gets the specified Compute Global Image Capability Schema
1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 |
# File 'lib/oci/core/compute_client.rb', line 1851 def get_compute_global_image_capability_schema(compute_global_image_capability_schema_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_compute_global_image_capability_schema.' if logger raise "Missing the required parameter 'compute_global_image_capability_schema_id' when calling get_compute_global_image_capability_schema." if compute_global_image_capability_schema_id.nil? raise "Parameter value for 'compute_global_image_capability_schema_id' must not be blank" if OCI::Internal::Util.blank_string?(compute_global_image_capability_schema_id) path = '/computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}'.sub('{computeGlobalImageCapabilitySchemaId}', compute_global_image_capability_schema_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_compute_global_image_capability_schema') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ComputeGlobalImageCapabilitySchema' ) end # rubocop:enable Metrics/BlockLength end |
#get_compute_global_image_capability_schema_version(compute_global_image_capability_schema_id, compute_global_image_capability_schema_version_name, opts = {}) ⇒ Response
Gets the specified Compute Global Image Capability Schema Version
1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 |
# File 'lib/oci/core/compute_client.rb', line 1905 def get_compute_global_image_capability_schema_version(compute_global_image_capability_schema_id, compute_global_image_capability_schema_version_name, opts = {}) logger.debug 'Calling operation ComputeClient#get_compute_global_image_capability_schema_version.' if logger raise "Missing the required parameter 'compute_global_image_capability_schema_id' when calling get_compute_global_image_capability_schema_version." if compute_global_image_capability_schema_id.nil? raise "Missing the required parameter 'compute_global_image_capability_schema_version_name' when calling get_compute_global_image_capability_schema_version." if compute_global_image_capability_schema_version_name.nil? raise "Parameter value for 'compute_global_image_capability_schema_id' must not be blank" if OCI::Internal::Util.blank_string?(compute_global_image_capability_schema_id) raise "Parameter value for 'compute_global_image_capability_schema_version_name' must not be blank" if OCI::Internal::Util.blank_string?(compute_global_image_capability_schema_version_name) path = '/computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions/{computeGlobalImageCapabilitySchemaVersionName}'.sub('{computeGlobalImageCapabilitySchemaId}', compute_global_image_capability_schema_id.to_s).sub('{computeGlobalImageCapabilitySchemaVersionName}', compute_global_image_capability_schema_version_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_compute_global_image_capability_schema_version') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ComputeGlobalImageCapabilitySchemaVersion' ) end # rubocop:enable Metrics/BlockLength end |
#get_compute_image_capability_schema(compute_image_capability_schema_id, opts = {}) ⇒ Response
Gets the specified Compute Image Capability Schema
1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 |
# File 'lib/oci/core/compute_client.rb', line 1962 def get_compute_image_capability_schema(compute_image_capability_schema_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_compute_image_capability_schema.' if logger raise "Missing the required parameter 'compute_image_capability_schema_id' when calling get_compute_image_capability_schema." if compute_image_capability_schema_id.nil? raise "Parameter value for 'compute_image_capability_schema_id' must not be blank" if OCI::Internal::Util.blank_string?(compute_image_capability_schema_id) path = '/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}'.sub('{computeImageCapabilitySchemaId}', compute_image_capability_schema_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:isMergeEnabled] = opts[:is_merge_enabled] if !opts[:is_merge_enabled].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_compute_image_capability_schema') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ComputeImageCapabilitySchema' ) end # rubocop:enable Metrics/BlockLength end |
#get_console_history(instance_console_history_id, opts = {}) ⇒ Response
Shows the metadata for the specified console history. See capture_console_history for details about using the console history operations.
2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 |
# File 'lib/oci/core/compute_client.rb', line 2018 def get_console_history(instance_console_history_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_console_history.' if logger raise "Missing the required parameter 'instance_console_history_id' when calling get_console_history." if instance_console_history_id.nil? raise "Parameter value for 'instance_console_history_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_console_history_id) path = '/instanceConsoleHistories/{instanceConsoleHistoryId}'.sub('{instanceConsoleHistoryId}', instance_console_history_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_console_history') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ConsoleHistory' ) end # rubocop:enable Metrics/BlockLength end |
#get_console_history_content(instance_console_history_id, opts = {}) ⇒ Response
Gets the actual console history data (not the metadata). See capture_console_history for details about using the console history operations.
2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 |
# File 'lib/oci/core/compute_client.rb', line 2075 def get_console_history_content(instance_console_history_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_console_history_content.' if logger raise "Missing the required parameter 'instance_console_history_id' when calling get_console_history_content." if instance_console_history_id.nil? raise "Parameter value for 'instance_console_history_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_console_history_id) path = '/instanceConsoleHistories/{instanceConsoleHistoryId}/data'.sub('{instanceConsoleHistoryId}', instance_console_history_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:offset] = opts[:offset] if opts[:offset] query_params[:length] = opts[:length] if opts[:length] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_console_history_content') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'String' ) end # rubocop:enable Metrics/BlockLength end |
#get_dedicated_vm_host(dedicated_vm_host_id, opts = {}) ⇒ Response
Gets information about the specified dedicated virtual machine host.
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 |
# File 'lib/oci/core/compute_client.rb', line 2131 def get_dedicated_vm_host(dedicated_vm_host_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_dedicated_vm_host.' if logger raise "Missing the required parameter 'dedicated_vm_host_id' when calling get_dedicated_vm_host." if dedicated_vm_host_id.nil? raise "Parameter value for 'dedicated_vm_host_id' must not be blank" if OCI::Internal::Util.blank_string?(dedicated_vm_host_id) path = '/dedicatedVmHosts/{dedicatedVmHostId}'.sub('{dedicatedVmHostId}', dedicated_vm_host_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_dedicated_vm_host') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DedicatedVmHost' ) end # rubocop:enable Metrics/BlockLength end |
#get_image(image_id, opts = {}) ⇒ Response
Gets the specified image.
2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 |
# File 'lib/oci/core/compute_client.rb', line 2184 def get_image(image_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_image.' if logger raise "Missing the required parameter 'image_id' when calling get_image." if image_id.nil? raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id) path = '/images/{imageId}'.sub('{imageId}', image_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_image') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Image' ) end # rubocop:enable Metrics/BlockLength end |
#get_image_shape_compatibility_entry(image_id, shape_name, opts = {}) ⇒ Response
Retrieves an image shape compatibility entry.
2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 |
# File 'lib/oci/core/compute_client.rb', line 2240 def get_image_shape_compatibility_entry(image_id, shape_name, opts = {}) logger.debug 'Calling operation ComputeClient#get_image_shape_compatibility_entry.' if logger raise "Missing the required parameter 'image_id' when calling get_image_shape_compatibility_entry." if image_id.nil? raise "Missing the required parameter 'shape_name' when calling get_image_shape_compatibility_entry." if shape_name.nil? raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id) raise "Parameter value for 'shape_name' must not be blank" if OCI::Internal::Util.blank_string?(shape_name) path = '/images/{imageId}/shapes/{shapeName}'.sub('{imageId}', image_id.to_s).sub('{shapeName}', shape_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_image_shape_compatibility_entry') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ImageShapeCompatibilityEntry' ) end # rubocop:enable Metrics/BlockLength end |
#get_instance(instance_id, opts = {}) ⇒ Response
Gets information about the specified instance.
2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 |
# File 'lib/oci/core/compute_client.rb', line 2295 def get_instance(instance_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_instance.' if logger raise "Missing the required parameter 'instance_id' when calling get_instance." if instance_id.nil? raise "Parameter value for 'instance_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_id) path = '/instances/{instanceId}'.sub('{instanceId}', instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_instance') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Instance' ) end # rubocop:enable Metrics/BlockLength end |
#get_instance_console_connection(instance_console_connection_id, opts = {}) ⇒ Response
Gets the specified instance console connection’s information.
2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 |
# File 'lib/oci/core/compute_client.rb', line 2348 def get_instance_console_connection(instance_console_connection_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_instance_console_connection.' if logger raise "Missing the required parameter 'instance_console_connection_id' when calling get_instance_console_connection." if instance_console_connection_id.nil? raise "Parameter value for 'instance_console_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_console_connection_id) path = '/instanceConsoleConnections/{instanceConsoleConnectionId}'.sub('{instanceConsoleConnectionId}', instance_console_connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_instance_console_connection') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::InstanceConsoleConnection' ) end # rubocop:enable Metrics/BlockLength end |
#get_vnic_attachment(vnic_attachment_id, opts = {}) ⇒ Response
Gets the information for the specified VNIC attachment.
2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 |
# File 'lib/oci/core/compute_client.rb', line 2402 def (, opts = {}) logger.debug 'Calling operation ComputeClient#get_vnic_attachment.' if logger raise "Missing the required parameter 'vnic_attachment_id' when calling get_vnic_attachment." if .nil? raise "Parameter value for 'vnic_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/vnicAttachments/{vnicAttachmentId}'.sub('{vnicAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_vnic_attachment') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::VnicAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#get_volume_attachment(volume_attachment_id, opts = {}) ⇒ Response
Gets information about the specified volume attachment.
2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 |
# File 'lib/oci/core/compute_client.rb', line 2455 def (, opts = {}) logger.debug 'Calling operation ComputeClient#get_volume_attachment.' if logger raise "Missing the required parameter 'volume_attachment_id' when calling get_volume_attachment." if .nil? raise "Parameter value for 'volume_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/volumeAttachments/{volumeAttachmentId}'.sub('{volumeAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_volume_attachment') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::VolumeAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#get_windows_instance_initial_credentials(instance_id, opts = {}) ⇒ Response
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.
2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 |
# File 'lib/oci/core/compute_client.rb', line 2510 def get_windows_instance_initial_credentials(instance_id, opts = {}) logger.debug 'Calling operation ComputeClient#get_windows_instance_initial_credentials.' if logger raise "Missing the required parameter 'instance_id' when calling get_windows_instance_initial_credentials." if instance_id.nil? raise "Parameter value for 'instance_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_id) path = '/instances/{instanceId}/initialCredentials'.sub('{instanceId}', instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#get_windows_instance_initial_credentials') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::InstanceCredentials' ) end # rubocop:enable Metrics/BlockLength end |
#instance_action(instance_id, action, opts = {}) ⇒ Response
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.
If the applications that run on the instance take a long time to shut down, they could be improperly stopped, resulting in data corruption. To avoid this, 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, and
then powers the instance back on.
For more information, see [Stopping and Starting an Instance](docs.cloud.oracle.com/Content/Compute/Tasks/restartinginstance.htm).
2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 |
# File 'lib/oci/core/compute_client.rb', line 2591 def instance_action(instance_id, action, opts = {}) logger.debug 'Calling operation ComputeClient#instance_action.' if logger raise "Missing the required parameter 'instance_id' when calling instance_action." if instance_id.nil? raise "Missing the required parameter 'action' when calling instance_action." if action.nil? unless %w[STOP START SOFTRESET RESET SOFTSTOP SENDDIAGNOSTICINTERRUPT].include?(action) raise "Invalid value for 'action', must be one of STOP, START, SOFTRESET, RESET, SOFTSTOP, SENDDIAGNOSTICINTERRUPT." end raise "Parameter value for 'instance_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_id) path = '/instances/{instanceId}'.sub('{instanceId}', instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:action] = action # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#instance_action') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Instance' ) end # rubocop:enable Metrics/BlockLength end |
#launch_instance(launch_instance_details, opts = {}) ⇒ Response
Creates a new instance in the specified compartment and the specified availability domain. For general information about instances, see [Overview of the Compute Service](docs.cloud.oracle.com/Content/Compute/Concepts/computeoverview.htm).
For information about access control and compartments, see [Overview of the IAM Service](docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and Availability Domains](docs.cloud.oracle.com/Content/General/Concepts/regions.htm). 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 LaunchInstanceDetails.
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 operation to get the VNIC ID for the instance, and then call get_vnic with the VNIC ID.
You can later add secondary VNICs to an instance. For more information, see [Virtual Network Interface Cards (VNICs)](docs.cloud.oracle.com/Content/Network/Tasks/managingVNICs.htm).
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 operation to get the signature for the terms of use agreement for the desired listing resource version. Then, call create_app_catalog_subscription with the signature. To get the image ID for the LaunchInstance operation, call get_app_catalog_listing_resource_version.
2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 |
# File 'lib/oci/core/compute_client.rb', line 2695 def launch_instance(launch_instance_details, opts = {}) logger.debug 'Calling operation ComputeClient#launch_instance.' if logger raise "Missing the required parameter 'launch_instance_details' when calling launch_instance." if launch_instance_details.nil? path = '/instances/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(launch_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#launch_instance') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Instance' ) end # rubocop:enable Metrics/BlockLength end |
#list_app_catalog_listing_resource_versions(listing_id, opts = {}) ⇒ Response
Gets all resource versions for a particular listing.
2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 |
# File 'lib/oci/core/compute_client.rb', line 2761 def list_app_catalog_listing_resource_versions(listing_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_app_catalog_listing_resource_versions.' if logger raise "Missing the required parameter 'listing_id' when calling list_app_catalog_listing_resource_versions." if listing_id.nil? if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'listing_id' must not be blank" if OCI::Internal::Util.blank_string?(listing_id) path = '/appCatalogListings/{listingId}/resourceVersions'.sub('{listingId}', listing_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_app_catalog_listing_resource_versions') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::AppCatalogListingResourceVersionSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_app_catalog_listings(opts = {}) ⇒ Response
Lists the published listings.
2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 |
# File 'lib/oci/core/compute_client.rb', line 2838 def list_app_catalog_listings(opts = {}) logger.debug 'Calling operation ComputeClient#list_app_catalog_listings.' if logger if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/appCatalogListings' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:publisherName] = opts[:publisher_name] if opts[:publisher_name] query_params[:publisherType] = opts[:publisher_type] if opts[:publisher_type] query_params[:displayName] = opts[:display_name] if opts[:display_name] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_app_catalog_listings') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::AppCatalogListingSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_app_catalog_subscriptions(compartment_id, opts = {}) ⇒ Response
Lists subscriptions for a compartment.
2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 |
# File 'lib/oci/core/compute_client.rb', line 2923 def list_app_catalog_subscriptions(compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_app_catalog_subscriptions.' if logger raise "Missing the required parameter 'compartment_id' when calling list_app_catalog_subscriptions." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/appCatalogSubscriptions' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:listingId] = opts[:listing_id] if opts[:listing_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_app_catalog_subscriptions') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::AppCatalogSubscriptionSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_boot_volume_attachments(availability_domain, compartment_id, opts = {}) ⇒ Response
Lists the boot volume attachments in the specified compartment. You can filter the list by specifying an instance OCID, boot volume OCID, or both.
3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 |
# File 'lib/oci/core/compute_client.rb', line 3005 def (availability_domain, compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_boot_volume_attachments.' if logger raise "Missing the required parameter 'availability_domain' when calling list_boot_volume_attachments." if availability_domain.nil? raise "Missing the required parameter 'compartment_id' when calling list_boot_volume_attachments." if compartment_id.nil? path = '/bootVolumeAttachments/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:availabilityDomain] = availability_domain query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:instanceId] = opts[:instance_id] if opts[:instance_id] query_params[:bootVolumeId] = opts[:boot_volume_id] if opts[:boot_volume_id] # Header Params header_params = {} header_params[:accept] = 'application/json, application/x-json-stream' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_boot_volume_attachments') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::BootVolumeAttachment>' ) end # rubocop:enable Metrics/BlockLength end |
#list_compute_global_image_capability_schema_versions(compute_global_image_capability_schema_id, opts = {}) ⇒ Response
Lists Compute Global Image Capability Schema versions in the specified compartment.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 |
# File 'lib/oci/core/compute_client.rb', line 3089 def list_compute_global_image_capability_schema_versions(compute_global_image_capability_schema_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_compute_global_image_capability_schema_versions.' if logger raise "Missing the required parameter 'compute_global_image_capability_schema_id' when calling list_compute_global_image_capability_schema_versions." if compute_global_image_capability_schema_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'compute_global_image_capability_schema_id' must not be blank" if OCI::Internal::Util.blank_string?(compute_global_image_capability_schema_id) path = '/computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions'.sub('{computeGlobalImageCapabilitySchemaId}', compute_global_image_capability_schema_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_compute_global_image_capability_schema_versions') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::ComputeGlobalImageCapabilitySchemaVersionSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_compute_global_image_capability_schemas(opts = {}) ⇒ Response
Lists Compute Global Image Capability Schema in the specified compartment.
3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 |
# File 'lib/oci/core/compute_client.rb', line 3181 def list_compute_global_image_capability_schemas(opts = {}) logger.debug 'Calling operation ComputeClient#list_compute_global_image_capability_schemas.' if logger if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/computeGlobalImageCapabilitySchemas' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_compute_global_image_capability_schemas') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::ComputeGlobalImageCapabilitySchemaSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_compute_image_capability_schemas(opts = {}) ⇒ Response
Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.
3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 |
# File 'lib/oci/core/compute_client.rb', line 3273 def list_compute_image_capability_schemas(opts = {}) logger.debug 'Calling operation ComputeClient#list_compute_image_capability_schemas.' if logger if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/computeImageCapabilitySchemas' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:imageId] = opts[:image_id] if opts[:image_id] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_compute_image_capability_schemas') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::ComputeImageCapabilitySchemaSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_console_histories(compartment_id, opts = {}) ⇒ Response
Lists the console history metadata for the specified compartment or instance.
3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 |
# File 'lib/oci/core/compute_client.rb', line 3369 def list_console_histories(compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_console_histories.' if logger raise "Missing the required parameter 'compartment_id' when calling list_console_histories." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::ConsoleHistory::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::ConsoleHistory::LIFECYCLE_STATE_ENUM.' end path = '/instanceConsoleHistories/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:instanceId] = opts[:instance_id] if opts[:instance_id] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_console_histories') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::ConsoleHistory>' ) end # rubocop:enable Metrics/BlockLength end |
#list_dedicated_vm_host_instance_shapes(compartment_id, opts = {}) ⇒ Response
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.
3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 |
# File 'lib/oci/core/compute_client.rb', line 3460 def list_dedicated_vm_host_instance_shapes(compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_dedicated_vm_host_instance_shapes.' if logger raise "Missing the required parameter 'compartment_id' when calling list_dedicated_vm_host_instance_shapes." if compartment_id.nil? path = '/dedicatedVmHostInstanceShapes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:dedicatedVmHostShape] = opts[:dedicated_vm_host_shape] if opts[:dedicated_vm_host_shape] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_dedicated_vm_host_instance_shapes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DedicatedVmHostInstanceShapeSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_dedicated_vm_host_instances(compartment_id, dedicated_vm_host_id, opts = {}) ⇒ Response
Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.
3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 |
# File 'lib/oci/core/compute_client.rb', line 3549 def list_dedicated_vm_host_instances(compartment_id, dedicated_vm_host_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_dedicated_vm_host_instances.' if logger raise "Missing the required parameter 'compartment_id' when calling list_dedicated_vm_host_instances." if compartment_id.nil? raise "Missing the required parameter 'dedicated_vm_host_id' when calling list_dedicated_vm_host_instances." if dedicated_vm_host_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'dedicated_vm_host_id' must not be blank" if OCI::Internal::Util.blank_string?(dedicated_vm_host_id) path = '/dedicatedVmHosts/{dedicatedVmHostId}/instances'.sub('{dedicatedVmHostId}', dedicated_vm_host_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json, application/x-json-stream' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_dedicated_vm_host_instances') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DedicatedVmHostInstanceSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_dedicated_vm_host_shapes(compartment_id, opts = {}) ⇒ Response
Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.
3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 |
# File 'lib/oci/core/compute_client.rb', line 3636 def list_dedicated_vm_host_shapes(compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_dedicated_vm_host_shapes.' if logger raise "Missing the required parameter 'compartment_id' when calling list_dedicated_vm_host_shapes." if compartment_id.nil? path = '/dedicatedVmHostShapes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:instanceShapeName] = opts[:instance_shape_name] if opts[:instance_shape_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_dedicated_vm_host_shapes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DedicatedVmHostShapeSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_dedicated_vm_hosts(compartment_id, opts = {}) ⇒ Response
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.
3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 |
# File 'lib/oci/core/compute_client.rb', line 3733 def list_dedicated_vm_hosts(compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_dedicated_vm_hosts.' if logger raise "Missing the required parameter 'compartment_id' when calling list_dedicated_vm_hosts." if compartment_id.nil? if opts[:lifecycle_state] && !%w[CREATING ACTIVE UPDATING DELETING DELETED FAILED].include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of CREATING, ACTIVE, UPDATING, DELETING, DELETED, FAILED.' end if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/dedicatedVmHosts' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:instanceShapeName] = opts[:instance_shape_name] if opts[:instance_shape_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json, application/x-json-stream' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_dedicated_vm_hosts') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DedicatedVmHostSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_image_shape_compatibility_entries(image_id, opts = {}) ⇒ Response
Lists the compatible shapes for the specified image.
3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 |
# File 'lib/oci/core/compute_client.rb', line 3818 def list_image_shape_compatibility_entries(image_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_image_shape_compatibility_entries.' if logger raise "Missing the required parameter 'image_id' when calling list_image_shape_compatibility_entries." if image_id.nil? raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id) path = '/images/{imageId}/shapes'.sub('{imageId}', image_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_image_shape_compatibility_entries') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::ImageShapeCompatibilitySummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_images(compartment_id, opts = {}) ⇒ Response
Lists the available images in the specified compartment, including both [Oracle-provided images](docs.cloud.oracle.com/Content/Compute/References/images.htm) and [custom images](docs.cloud.oracle.com/Content/Compute/Tasks/managingcustomimages.htm) that have been created. The list of images returned is ordered to first show all Oracle-provided images, then all custom images.
The order of images returned may change when new images are released.
3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 |
# File 'lib/oci/core/compute_client.rb', line 3916 def list_images(compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_images.' if logger raise "Missing the required parameter 'compartment_id' when calling list_images." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::Image::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Image::LIFECYCLE_STATE_ENUM.' end path = '/images' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:operatingSystem] = opts[:operating_system] if opts[:operating_system] query_params[:operatingSystemVersion] = opts[:operating_system_version] if opts[:operating_system_version] query_params[:shape] = opts[:shape] if opts[:shape] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_images') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Image>' ) end # rubocop:enable Metrics/BlockLength end |
#list_instance_console_connections(compartment_id, opts = {}) ⇒ Response
Lists the console connections for the specified compartment or instance.
For more information about console access, see [Accessing the Console](docs.cloud.oracle.com/Content/Compute/References/serialconsole.htm).
4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 |
# File 'lib/oci/core/compute_client.rb', line 4002 def list_instance_console_connections(compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_instance_console_connections.' if logger raise "Missing the required parameter 'compartment_id' when calling list_instance_console_connections." if compartment_id.nil? path = '/instanceConsoleConnections' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:instanceId] = opts[:instance_id] if opts[:instance_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_instance_console_connections') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::InstanceConsoleConnection>' ) end # rubocop:enable Metrics/BlockLength end |
#list_instance_devices(instance_id, opts = {}) ⇒ Response
Gets a list of all the devices for given instance. You can optionally filter results by device availability.
4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 |
# File 'lib/oci/core/compute_client.rb', line 4087 def list_instance_devices(instance_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_instance_devices.' if logger raise "Missing the required parameter 'instance_id' when calling list_instance_devices." if instance_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'instance_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_id) path = '/instances/{instanceId}/devices'.sub('{instanceId}', instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:isAvailable] = opts[:is_available] if !opts[:is_available].nil? query_params[:name] = opts[:name] if opts[:name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_instance_devices') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Device>' ) end # rubocop:enable Metrics/BlockLength end |
#list_instances(compartment_id, opts = {}) ⇒ Response
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).
4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 |
# File 'lib/oci/core/compute_client.rb', line 4188 def list_instances(compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_instances.' if logger raise "Missing the required parameter 'compartment_id' when calling list_instances." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::Instance::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Instance::LIFECYCLE_STATE_ENUM.' end path = '/instances/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json, application/x-json-stream' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_instances') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Instance>' ) end # rubocop:enable Metrics/BlockLength end |
#list_shapes(compartment_id, opts = {}) ⇒ Response
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.
4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 |
# File 'lib/oci/core/compute_client.rb', line 4275 def list_shapes(compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_shapes.' if logger raise "Missing the required parameter 'compartment_id' when calling list_shapes." if compartment_id.nil? path = '/shapes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:imageId] = opts[:image_id] if opts[:image_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_shapes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Shape>' ) end # rubocop:enable Metrics/BlockLength end |
#list_vnic_attachments(compartment_id, opts = {}) ⇒ Response
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.
4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 |
# File 'lib/oci/core/compute_client.rb', line 4349 def (compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_vnic_attachments.' if logger raise "Missing the required parameter 'compartment_id' when calling list_vnic_attachments." if compartment_id.nil? path = '/vnicAttachments/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:instanceId] = opts[:instance_id] if opts[:instance_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:vnicId] = opts[:vnic_id] if opts[:vnic_id] # Header Params header_params = {} header_params[:accept] = 'application/json, application/x-json-stream' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_vnic_attachments') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::VnicAttachment>' ) end # rubocop:enable Metrics/BlockLength end |
#list_volume_attachments(compartment_id, opts = {}) ⇒ Response
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 IScsiVolumeAttachment and ParavirtualizedVolumeAttachment.
4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 |
# File 'lib/oci/core/compute_client.rb', line 4426 def (compartment_id, opts = {}) logger.debug 'Calling operation ComputeClient#list_volume_attachments.' if logger raise "Missing the required parameter 'compartment_id' when calling list_volume_attachments." if compartment_id.nil? path = '/volumeAttachments/' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:instanceId] = opts[:instance_id] if opts[:instance_id] query_params[:volumeId] = opts[:volume_id] if opts[:volume_id] # Header Params header_params = {} header_params[:accept] = 'application/json, application/x-json-stream' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#list_volume_attachments') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::VolumeAttachment>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
96 97 98 |
# File 'lib/oci/core/compute_client.rb', line 96 def logger @api_client.config.logger end |
#remove_image_shape_compatibility_entry(image_id, shape_name, opts = {}) ⇒ Response
Removes a shape from the compatible shapes list for the image.
4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 |
# File 'lib/oci/core/compute_client.rb', line 4484 def remove_image_shape_compatibility_entry(image_id, shape_name, opts = {}) logger.debug 'Calling operation ComputeClient#remove_image_shape_compatibility_entry.' if logger raise "Missing the required parameter 'image_id' when calling remove_image_shape_compatibility_entry." if image_id.nil? raise "Missing the required parameter 'shape_name' when calling remove_image_shape_compatibility_entry." if shape_name.nil? raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id) raise "Parameter value for 'shape_name' must not be blank" if OCI::Internal::Util.blank_string?(shape_name) path = '/images/{imageId}/shapes/{shapeName}'.sub('{imageId}', image_id.to_s).sub('{shapeName}', shape_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#remove_image_shape_compatibility_entry') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#terminate_instance(instance_id, opts = {}) ⇒ Response
Terminates 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` will change to TERMINATING temporarily until the instance is completely removed.
4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 |
# File 'lib/oci/core/compute_client.rb', line 4552 def terminate_instance(instance_id, opts = {}) logger.debug 'Calling operation ComputeClient#terminate_instance.' if logger raise "Missing the required parameter 'instance_id' when calling terminate_instance." if instance_id.nil? raise "Parameter value for 'instance_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_id) path = '/instances/{instanceId}'.sub('{instanceId}', instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:preserveBootVolume] = opts[:preserve_boot_volume] if !opts[:preserve_boot_volume].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#terminate_instance') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#update_compute_image_capability_schema(compute_image_capability_schema_id, update_compute_image_capability_schema_details, opts = {}) ⇒ Response
Updates the specified Compute Image Capability Schema
4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 |
# File 'lib/oci/core/compute_client.rb', line 4610 def update_compute_image_capability_schema(compute_image_capability_schema_id, update_compute_image_capability_schema_details, opts = {}) logger.debug 'Calling operation ComputeClient#update_compute_image_capability_schema.' if logger raise "Missing the required parameter 'compute_image_capability_schema_id' when calling update_compute_image_capability_schema." if compute_image_capability_schema_id.nil? raise "Missing the required parameter 'update_compute_image_capability_schema_details' when calling update_compute_image_capability_schema." if update_compute_image_capability_schema_details.nil? raise "Parameter value for 'compute_image_capability_schema_id' must not be blank" if OCI::Internal::Util.blank_string?(compute_image_capability_schema_id) path = '/computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}'.sub('{computeImageCapabilitySchemaId}', compute_image_capability_schema_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_compute_image_capability_schema_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#update_compute_image_capability_schema') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ComputeImageCapabilitySchema' ) end # rubocop:enable Metrics/BlockLength end |
#update_console_history(instance_console_history_id, update_console_history_details, opts = {}) ⇒ Response
Updates the specified console history metadata.
4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 |
# File 'lib/oci/core/compute_client.rb', line 4668 def update_console_history(instance_console_history_id, update_console_history_details, opts = {}) logger.debug 'Calling operation ComputeClient#update_console_history.' if logger raise "Missing the required parameter 'instance_console_history_id' when calling update_console_history." if instance_console_history_id.nil? raise "Missing the required parameter 'update_console_history_details' when calling update_console_history." if update_console_history_details.nil? raise "Parameter value for 'instance_console_history_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_console_history_id) path = '/instanceConsoleHistories/{instanceConsoleHistoryId}'.sub('{instanceConsoleHistoryId}', instance_console_history_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_console_history_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#update_console_history') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ConsoleHistory' ) end # rubocop:enable Metrics/BlockLength end |
#update_dedicated_vm_host(dedicated_vm_host_id, update_dedicated_vm_host_details, opts = {}) ⇒ Response
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.
4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 |
# File 'lib/oci/core/compute_client.rb', line 4737 def update_dedicated_vm_host(dedicated_vm_host_id, update_dedicated_vm_host_details, opts = {}) logger.debug 'Calling operation ComputeClient#update_dedicated_vm_host.' if logger raise "Missing the required parameter 'dedicated_vm_host_id' when calling update_dedicated_vm_host." if dedicated_vm_host_id.nil? raise "Missing the required parameter 'update_dedicated_vm_host_details' when calling update_dedicated_vm_host." if update_dedicated_vm_host_details.nil? raise "Parameter value for 'dedicated_vm_host_id' must not be blank" if OCI::Internal::Util.blank_string?(dedicated_vm_host_id) path = '/dedicatedVmHosts/{dedicatedVmHostId}'.sub('{dedicatedVmHostId}', dedicated_vm_host_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_dedicated_vm_host_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#update_dedicated_vm_host') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DedicatedVmHost' ) end # rubocop:enable Metrics/BlockLength end |
#update_image(image_id, update_image_details, opts = {}) ⇒ Response
Updates the display name of the image. Avoid entering confidential information.
4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 |
# File 'lib/oci/core/compute_client.rb', line 4804 def update_image(image_id, update_image_details, opts = {}) logger.debug 'Calling operation ComputeClient#update_image.' if logger raise "Missing the required parameter 'image_id' when calling update_image." if image_id.nil? raise "Missing the required parameter 'update_image_details' when calling update_image." if update_image_details.nil? raise "Parameter value for 'image_id' must not be blank" if OCI::Internal::Util.blank_string?(image_id) path = '/images/{imageId}'.sub('{imageId}', image_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_image_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#update_image') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Image' ) end # rubocop:enable Metrics/BlockLength end |
#update_instance(instance_id, update_instance_details, opts = {}) ⇒ Response
Updates certain fields on the specified instance. Fields that are not provided in the request will not be updated. Avoid entering confidential information.
The OCID of the instance remains the same.
4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 |
# File 'lib/oci/core/compute_client.rb', line 4874 def update_instance(instance_id, update_instance_details, opts = {}) logger.debug 'Calling operation ComputeClient#update_instance.' if logger raise "Missing the required parameter 'instance_id' when calling update_instance." if instance_id.nil? raise "Missing the required parameter 'update_instance_details' when calling update_instance." if update_instance_details.nil? raise "Parameter value for 'instance_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_id) path = '/instances/{instanceId}'.sub('{instanceId}', instance_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_instance_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#update_instance') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Instance' ) end # rubocop:enable Metrics/BlockLength end |
#update_instance_console_connection(instance_console_connection_id, update_instance_console_connection_details, opts = {}) ⇒ Response
Updates the defined tags and free-form tags for the specified instance console connection.
4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'lib/oci/core/compute_client.rb', line 4937 def update_instance_console_connection(instance_console_connection_id, update_instance_console_connection_details, opts = {}) logger.debug 'Calling operation ComputeClient#update_instance_console_connection.' if logger raise "Missing the required parameter 'instance_console_connection_id' when calling update_instance_console_connection." if instance_console_connection_id.nil? raise "Missing the required parameter 'update_instance_console_connection_details' when calling update_instance_console_connection." if update_instance_console_connection_details.nil? raise "Parameter value for 'instance_console_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(instance_console_connection_id) path = '/instanceConsoleConnections/{instanceConsoleConnectionId}'.sub('{instanceConsoleConnectionId}', instance_console_connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_instance_console_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'ComputeClient#update_instance_console_connection') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::InstanceConsoleConnection' ) end # rubocop:enable Metrics/BlockLength end |