lib/oci/key_management/kms_vault_client.rb
# Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later.
# You can backup a vault whether or not it contains keys. This operation only backs up the
# metadata of the vault, and does not include key metadata.
#
# @param [String] vault_id The OCID of the vault.
# @param [Hash] opts the optional parameters
# @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level
#   retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry
# @option opts [String] :if_match For optimistic concurrency control. In the PUT or DELETE call for a
#   resource, set the `if-match` parameter to the value of the etag from a
#   previous GET or POST response for that resource. The resource will be
#   updated or deleted only if the etag you provide matches the resource's
#   current etag value.
#
# @option opts [String] :opc_request_id Unique identifier for the request. If provided, the returned request ID
#   will include this value. Otherwise, a random request ID will be
#   generated by the service.
#
# @option opts [String] :opc_retry_token A token that uniquely identifies a request so it can be retried in case
#   of a timeout or server error without risk of executing that same action
#   again. Retry tokens expire after 24 hours, but can be invalidated
#   before then due to conflicting operations (e.g., if a resource has been
#   deleted and purged from the system, then a retry of the original
#   creation request may be rejected).
#
# @option opts [OCI::KeyManagement::Models::BackupVaultDetails] :backup_vault_details BackupVaultDetails
# @return [Response] A Response object with data of type {OCI::KeyManagement::Models::Vault Vault}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/keymanagement/backup_vault.rb.html) to see an example of how to use backup_vault API.
Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later.
You can backup a vault whether or not it contains keys. This operation only backs up the
metadata of the vault, and does not include key metadata.
Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later . You can backup a vault whether or not it contains keys . This operation only backs up the metadata of the vault and does not include key metadata .
def backup_vault(vault_id, opts = {})
      logger.debug 'Calling operation KmsVaultClient#backup_vault.' if logger
      raise "Missing the required parameter 'vault_id' when calling backup_vault." if vault_id.nil?
      raise "Parameter value for 'vault_id' must not be blank" if OCI::Internal::Util.blank_string?(vault_id)
      path = '/20180608/vaults/{vaultId}/actions/backup'.sub('{vaultId}', vault_id.to_s)
      operation_signing_strategy = :standard
      query_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]
      header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token
      post_body = @api_client.object_to_http_body(opts[:backup_vault_details])
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsVaultClient#backup_vault') 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::KeyManagement::Models::Vault'
        )
      end
    end
def backup_vault ( vault_id , opts = { } ) logger . debug 'Calling operation KmsVaultClient#backup_vault.' if logger raise "Missing the required parameter 'vault_id' when calling backup_vault." if vault_id . nil? raise "Parameter value for 'vault_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( vault_id ) path = '/20180608/vaults/{vaultId}/actions/backup' . sub ( '{vaultId}' , vault_id . to_s ) operation_signing_strategy = :standard query_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 ] header_params [ :' opc-retry-token ' ] ||= OCI :: Retry . generate_opc_retry_token post_body = @api_client . object_to_http_body ( opts [ :backup_vault_details ] ) OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'KmsVaultClient#backup_vault' ) 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::KeyManagement::Models::Vault' ) end end
Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later.
Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later .
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type {OCI::KeyManagement::Models::Vault Vault}
A Response object with data of type { OCI :: KeyManagement :: Models :: Vault Vault }
Response
vault_id
opts
None
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use backup_vault API.
Click [ here ] to see an example of how to use backup_vault API .