lib/oci/core/virtual_network_client.rb
# Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.
# Each `ByoipAllocatedRange` object also lists the IP pool where it is allocated.
#
# @param [String] byoip_range_id The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block.
# @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] :opc_request_id Unique identifier for the request.
#   If you need to contact Oracle about a particular request, please provide the request ID.
#
# @option opts [Integer] :limit For list pagination. The maximum number of results per page, or items to return in a paginated
#   \"List\" call. For important details about how pagination works, see
#   [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
#
#   Example: `50`
#
# @option opts [String] :page For list pagination. The value of the `opc-next-page` response header from the previous \"List\"
#   call. For important details about how pagination works, see
#   [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).
#
# @return [Response] A Response object with data of type {OCI::Core::Models::ByoipAllocatedRangeCollection ByoipAllocatedRangeCollection}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/core/list_byoip_allocated_ranges.rb.html) to see an example of how to use list_byoip_allocated_ranges API.
Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.
Each `ByoipAllocatedRange` object also lists the IP pool where it is allocated.
Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool . Each ` ByoipAllocatedRange ` object also lists the IP pool where it is allocated .
def list_byoip_allocated_ranges(byoip_range_id, opts = {})
      logger.debug 'Calling operation VirtualNetworkClient#list_byoip_allocated_ranges.' if logger
      raise "Missing the required parameter 'byoip_range_id' when calling list_byoip_allocated_ranges." if byoip_range_id.nil?
      raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id)
      path = '/byoipRanges/{byoipRangeId}/byoipAllocatedRanges'.sub('{byoipRangeId}', byoip_range_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]
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
      post_body = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_byoip_allocated_ranges') 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::ByoipAllocatedRangeCollection'
        )
      end
    end
def list_byoip_allocated_ranges ( byoip_range_id , opts = { } ) logger . debug 'Calling operation VirtualNetworkClient#list_byoip_allocated_ranges.' if logger raise "Missing the required parameter 'byoip_range_id' when calling list_byoip_allocated_ranges." if byoip_range_id . nil? raise "Parameter value for 'byoip_range_id' must not be blank" if OCI :: Internal :: Util . blank_string? ( byoip_range_id ) path = '/byoipRanges/{byoipRangeId}/byoipAllocatedRanges' . sub ( '{byoipRangeId}' , byoip_range_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 ] header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' header_params [ :' opc-request-id ' ] = opts [ :opc_request_id ] if opts [ :opc_request_id ] post_body = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'VirtualNetworkClient#list_byoip_allocated_ranges' ) 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::ByoipAllocatedRangeCollection' ) end end
Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.
Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool .
# 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::Core::Models::ByoipAllocatedRangeCollection ByoipAllocatedRangeCollection}
A Response object with data of type { OCI :: Core :: Models :: ByoipAllocatedRangeCollection ByoipAllocatedRangeCollection }
Response
byoip_range_id
opts
:page For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see [List Pagination].
: page For list pagination . The value of the ` opc - next - page ` response header from the previous \ " List \ " call . For important details about how pagination works see [ List Pagination ] .
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_byoip_allocated_ranges API.
Click [ here ] to see an example of how to use list_byoip_allocated_ranges API .