lib/oci/identity/identity_client.rb
# Lists the availability domains in your tenancy. Specify the OCID of either the tenancy or another
# of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).
# See [Where to Get the Tenancy's OCID and User's OCID](https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
# Note that the order of the results returned can change if availability domains are added or removed; therefore, do not
# create a dependency on the list order.
#
# @param [String] compartment_id The OCID of the compartment (remember that the tenancy is simply the root compartment).
#
# @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
# @return [Response] A Response object with data of type Array<{OCI::Identity::Models::AvailabilityDomain AvailabilityDomain}>
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/identity/list_availability_domains.rb.html) to see an example of how to use list_availability_domains API.
Lists the availability domains in your tenancy. Specify the OCID of either the tenancy or another
of your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).
See [Where to Get the Tenancy's OCID and User's OCID].
Note that the order of the results returned can change if availability domains are added or removed; therefore, do not
create a dependency on the list order.
Lists the availability domains in your tenancy . Specify the OCID of either the tenancy or another of your compartments as the value for the compartment ID ( remember that the tenancy is simply the root compartment ) . See [ Where to Get the Tenancy ' s OCID and User ' s OCID ] . Note that the order of the results returned can change if availability domains are added or removed ; therefore do not create a dependency on the list order .
def list_availability_domains(compartment_id, opts = {})
      logger.debug 'Calling operation IdentityClient#list_availability_domains.' if logger
      raise "Missing the required parameter 'compartment_id' when calling list_availability_domains." if compartment_id.nil?
      path = '/availabilityDomains/'
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:compartmentId] = compartment_id
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      post_body = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IdentityClient#list_availability_domains') 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::Identity::Models::AvailabilityDomain>'
        )
      end
    end
def list_availability_domains ( compartment_id , opts = { } ) logger . debug 'Calling operation IdentityClient#list_availability_domains.' if logger raise "Missing the required parameter 'compartment_id' when calling list_availability_domains." if compartment_id . nil? path = '/availabilityDomains/' operation_signing_strategy = :standard query_params = { } query_params [ :compartmentId ] = compartment_id header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' post_body = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'IdentityClient#list_availability_domains' ) 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::Identity::Models::AvailabilityDomain>' ) end end
Lists the availability domains in your tenancy.
Lists the availability domains in your tenancy .
# 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::Identity::Models::AvailabilityDomain AvailabilityDomain}>
A Response object with data of type Array< { OCI :: Identity :: Models :: AvailabilityDomain AvailabilityDomain } >
Response
compartment_id
<not_specific>
opts
: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
: 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
<not_specific>
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_availability_domains API.
Click [ here ] to see an example of how to use list_availability_domains API .