Class: OCI::Core::ComputeClient
- Inherits:
-
Object
- Object
- OCI::Core::ComputeClient
- Defined in:
- lib/oci/core/compute_client.rb
Overview
APIs for Networking Service, Compute Service, and Block Volume Service.
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
-
#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.
-
#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_console_history(instance_console_history_id, opts = {}) ⇒ Response
Deletes the specified console history metadata and the console history data.
-
#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_boot_volume_attachment(boot_volume_attachment_id, opts = {}) ⇒ Response
Gets information about the specified boot volume attachment.
-
#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_image(image_id, opts = {}) ⇒ Response
Gets the specified image.
-
#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, 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_boot_volume_attachments(availability_domain, compartment_id, opts = {}) ⇒ Response
Lists the boot volume attachments in the specified compartment.
-
#list_console_histories(compartment_id, opts = {}) ⇒ Response
Lists the console history metadata for the specified compartment or instance.
-
#list_images(compartment_id, opts = {}) ⇒ Response
Lists the available images in the specified compartment, including both [Oracle-provided images](docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/images.htm) and [custom images](docs.us-phoenix-1.oraclecloud.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_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.
-
#terminate_instance(instance_id, opts = {}) ⇒ Response
Terminates the specified instance.
-
#update_console_history(instance_console_history_id, update_console_history_details, opts = {}) ⇒ Response
Updates the specified console history metadata.
-
#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 the display name of the specified instance.
Constructor Details
#initialize(config: nil, region: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ ComputeClient
Creates a new ComputeClient. If a config is not specified, then the global OCI.config will be used.
A region must be specified in either the config or the region parameter. If specified in both, then the region parameter will be used.
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/oci/core/compute_client.rb', line 48 def initialize(config: nil, region: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals) # 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 unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner) if signer.nil? signer = OCI::Signer.new( config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content ) end @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
12 13 14 |
# File 'lib/oci/core/compute_client.rb', line 12 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
16 17 18 |
# File 'lib/oci/core/compute_client.rb', line 16 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
26 27 28 |
# File 'lib/oci/core/compute_client.rb', line 26 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
22 23 24 |
# File 'lib/oci/core/compute_client.rb', line 22 def retry_config @retry_config end |
Instance Method Details
#attach_boot_volume(attach_boot_volume_details, opts = {}) ⇒ Response
Attaches the specified boot volume to the specified instance.
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 151 |
# File 'lib/oci/core/compute_client.rb', line 115 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.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).
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 210 211 212 |
# File 'lib/oci/core/compute_client.rb', line 176 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.
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 271 |
# File 'lib/oci/core/compute_client.rb', line 235 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.
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/oci/core/compute_client.rb', line 310 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 |
#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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm#URLs) and [pre-authenticated requests](docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingaccess.htm#pre-auth) for constructing URLs for image import/export.
For more information about importing exported images, see [Image Import/Export](docs.us-phoenix-1.oraclecloud.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.
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 |
# File 'lib/oci/core/compute_client.rb', line 391 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. Once 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.us-phoenix-1.oraclecloud.com/Content/Compute/References/serialconsole.htm).
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 |
# File 'lib/oci/core/compute_client.rb', line 454 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_console_history(instance_console_history_id, opts = {}) ⇒ Response
Deletes the specified console history metadata and the console history data.
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 510 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_image(image_id, opts = {}) ⇒ Response
Deletes an image.
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 |
# File 'lib/oci/core/compute_client.rb', line 565 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.
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 |
# File 'lib/oci/core/compute_client.rb', line 620 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.
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 |
# File 'lib/oci/core/compute_client.rb', line 679 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.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingroutetables.htm#privateip), deleting the VNIC causes that route rule to blackhole and the traffic will be dropped.
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 |
# File 'lib/oci/core/compute_client.rb', line 744 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.
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 |
# File 'lib/oci/core/compute_client.rb', line 803 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.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/commonpolicies.htm#Let4).
See [Object Storage URLs](docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/imageimportexport.htm#URLs) and [pre-authenticated requests](docs.us-phoenix-1.oraclecloud.com/Content/Object/Tasks/managingaccess.htm#pre-auth) for constructing URLs for image import/export.
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 |
# File 'lib/oci/core/compute_client.rb', line 875 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_boot_volume_attachment(boot_volume_attachment_id, opts = {}) ⇒ Response
Gets information about the specified boot volume attachment.
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 958 959 960 961 962 963 964 965 966 |
# File 'lib/oci/core/compute_client.rb', line 931 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_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.
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 1021 1022 |
# File 'lib/oci/core/compute_client.rb', line 987 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.
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 1078 1079 1080 1081 |
# File 'lib/oci/core/compute_client.rb', line 1044 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_image(image_id, opts = {}) ⇒ Response
Gets the specified image.
1098 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 |
# File 'lib/oci/core/compute_client.rb', line 1098 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_instance(instance_id, opts = {}) ⇒ Response
Gets information about the specified instance.
1151 1152 1153 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 |
# File 'lib/oci/core/compute_client.rb', line 1151 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.
1204 1205 1206 1207 1208 1209 1210 1211 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 |
# File 'lib/oci/core/compute_client.rb', line 1204 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.
1258 1259 1260 1261 1262 1263 1264 1265 1266 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 |
# File 'lib/oci/core/compute_client.rb', line 1258 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.
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 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 |
# File 'lib/oci/core/compute_client.rb', line 1311 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 password to log in (E.g. Windows). For certain OS’es, users will be forced to change the initial credentials.
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 |
# File 'lib/oci/core/compute_client.rb', line 1366 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.
-
SOFTRESET - Gracefully reboots instance by sending a shutdown command to the operating system and then powers the instance back on.
-
SOFTSTOP - Gracefully shuts down instance by sending a shutdown command to the operating system.
-
RESET - Powers off the instance and then powers it back on.
For more information see [Stopping and Starting an Instance](docs.us-phoenix-1.oraclecloud.com/Content/Compute/Tasks/restartinginstance.htm).
1443 1444 1445 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 1482 1483 1484 1485 1486 |
# File 'lib/oci/core/compute_client.rb', line 1443 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].include?(action) raise "Invalid value for 'action', must be one of STOP, START, SOFTRESET, RESET, SOFTSTOP." 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.us-phoenix-1.oraclecloud.com/Content/Compute/Concepts/computeoverview.htm).
For information about access control and compartments, see [Overview of the IAM Service](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
For information about Availability Domains, see [Regions and Availability Domains](docs.us-phoenix-1.oraclecloud.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.us-phoenix-1.oraclecloud.com/Content/Network/Tasks/managingVNICs.htm).
1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 |
# File 'lib/oci/core/compute_client.rb', line 1539 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_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.
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 |
# File 'lib/oci/core/compute_client.rb', line 1605 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_console_histories(compartment_id, opts = {}) ⇒ Response
Lists the console history metadata for the specified compartment or instance.
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 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 |
# File 'lib/oci/core/compute_client.rb', line 1690 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_images(compartment_id, opts = {}) ⇒ Response
Lists the available images in the specified compartment, including both [Oracle-provided images](docs.us-phoenix-1.oraclecloud.com/Content/Compute/References/images.htm) and [custom images](docs.us-phoenix-1.oraclecloud.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.
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 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 |
# File 'lib/oci/core/compute_client.rb', line 1800 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.us-phoenix-1.oraclecloud.com/Content/Compute/References/serialconsole.htm).
1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 |
# File 'lib/oci/core/compute_client.rb', line 1882 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_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).
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 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 |
# File 'lib/oci/core/compute_client.rb', line 1967 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.
2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 |
# File 'lib/oci/core/compute_client.rb', line 2050 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.
2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 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 |
# File 'lib/oci/core/compute_client.rb', line 2120 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.
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 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 |
# File 'lib/oci/core/compute_client.rb', line 2193 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.
93 94 95 |
# File 'lib/oci/core/compute_client.rb', line 93 def logger @api_client.config.logger 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.
2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 |
# File 'lib/oci/core/compute_client.rb', line 2264 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_console_history(instance_console_history_id, update_console_history_details, opts = {}) ⇒ Response
Updates the specified console history metadata.
2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 |
# File 'lib/oci/core/compute_client.rb', line 2321 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_image(image_id, update_image_details, opts = {}) ⇒ Response
Updates the display name of the image. Avoid entering confidential information.
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 |
# File 'lib/oci/core/compute_client.rb', line 2385 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 the display name of the specified instance. Avoid entering confidential information. The OCID of the instance remains the same.
2453 2454 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 2491 2492 |
# File 'lib/oci/core/compute_client.rb', line 2453 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 |