Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListPublicIpsRequest

example

Click here to see how to use ListPublicIpsRequest.

Properties

Optional availabilityDomain

availabilityDomain: undefined | string

The name of the availability domain.

Example: {@code Uocm:PHX-AD-1}

compartmentId

compartmentId: string

The OCID of the compartment.

Optional lifetime

lifetime: Lifetime

A filter to return only public IPs that match given lifetime.

Optional limit

limit: undefined | number

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.

Example: {@code 50}

Optional page

page: undefined | string

For list pagination. The value of the {@code opc-next-page} response header from the previous "List" call. For important details about how pagination works, see List Pagination.

Optional publicIpPoolId

publicIpPoolId: undefined | string

A filter to return only resources that belong to the given public IP pool.

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

scope

scope: Scope

Whether the public IP is regional or specific to a particular availability domain.

{@code REGION}: The public IP exists within a region and is assigned to a regional entity (such as a NatGateway), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs have {@code scope} = {@code REGION}, as do ephemeral public IPs assigned to a regional entity.

{@code AVAILABILITY_DOMAIN}: The public IP exists within the availability domain of the entity it's assigned to, which is specified by the {@code availabilityDomain} property of the public IP object. Ephemeral public IPs that are assigned to private IPs have {@code scope} = {@code AVAILABILITY_DOMAIN}.