lib/oci/key_management/kms_vault_client.rb
# Lists the replicas for a vault
#
# As a provisioning operation, this call is subject to a Key Management limit that applies to
# the total number of requests across all provisioning write operations. Key Management might
# throttle this call to reject an otherwise valid request when the total rate of provisioning
# write operations exceeds 10 requests per second for a given tenancy.
#
# @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 [Integer] :limit The maximum number of items to return in a paginated \"List\" call.
#
# @option opts [String] :page The value of the `opc-next-page` response header
#   from the previous \"List\" call.
#
# @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 [String] :sort_by The field to sort by. You can specify only one sort order. The default
#   order for `TIMECREATED` is descending. The default order for `DISPLAYNAME`
#   is ascending.
#
#   Allowed values are: TIMECREATED, DISPLAYNAME
# @option opts [String] :sort_order The sort order to use, either ascending (`ASC`) or descending (`DESC`).
#
#   Allowed values are: ASC, DESC
# @return [Response] A Response object with data of type Array<{OCI::KeyManagement::Models::VaultReplicaSummary VaultReplicaSummary}>
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/keymanagement/list_vault_replicas.rb.html) to see an example of how to use list_vault_replicas API.
Lists the replicas for a vault
As a provisioning operation, this call is subject to a Key Management limit that applies to
the total number of requests across all provisioning write operations. Key Management might
throttle this call to reject an otherwise valid request when the total rate of provisioning
write operations exceeds 10 requests per second for a given tenancy.
Lists the replicas for a vault As a provisioning operation this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations . Key Management might throttle this call to reject an otherwise valid request when the total rate of provisioning write operations exceeds 10 requests per second for a given tenancy .
def list_vault_replicas(vault_id, opts = {})
      logger.debug 'Calling operation KmsVaultClient#list_vault_replicas.' if logger
      raise "Missing the required parameter 'vault_id' when calling list_vault_replicas." if vault_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 'vault_id' must not be blank" if OCI::Internal::Util.blank_string?(vault_id)
      path = '/20180608/vaults/{vaultId}/actions/listReplicas'.sub('{vaultId}', vault_id.to_s)
      operation_signing_strategy = :standard
      query_params = {}
      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[: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 = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'KmsVaultClient#list_vault_replicas') 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::KeyManagement::Models::VaultReplicaSummary>'
        )
      end
    end
def list_vault_replicas ( vault_id , opts = { } ) logger . debug 'Calling operation KmsVaultClient#list_vault_replicas.' if logger raise "Missing the required parameter 'vault_id' when calling list_vault_replicas." if vault_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 'vault_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( vault_id ) path = '/20180608/vaults/{vaultId}/actions/listReplicas' . sub ( '{vaultId}' , vault_id . to_s ) operation_signing_strategy = :standard query_params = { } 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 [ :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 = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'KmsVaultClient#list_vault_replicas' ) 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::KeyManagement::Models::VaultReplicaSummary>' ) end end
Lists the replicas for a vault
As a provisioning operation, this call is subject to a Key Management limit that applies to
the total number of requests across all provisioning write operations.
Lists the replicas for a vault As a provisioning operation this call is subject to a Key Management limit that applies to the total number of requests across all provisioning write operations .
# 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 Array<{OCI::KeyManagement::Models::VaultReplicaSummary VaultReplicaSummary}>
A Response object with data of type Array< { OCI :: KeyManagement :: Models :: VaultReplicaSummary VaultReplicaSummary } >
Response
vault_id
opts
:sort_order The sort order to use, either ascending (`ASC`) or descending (`DESC`). Allowed values are: ASC, DESC
: sort_order The sort order to use either ascending ( ` ASC ` ) or descending ( ` DESC ` ) . Allowed values are : ASC DESC
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_vault_replicas API.
Click [ here ] to see an example of how to use list_vault_replicas API .