Jump to

• Request
• Response

ListPublicIps

get

/20160918/publicIps

List the PublicIp objects in the specified compartment. You can filter the list by using query parameters.

To list your reserved public IPs:

Set scope = REGION (required)

Leave the availabilityDomain parameter empty

Set lifetime = RESERVED

To list the ephemeral public IPs assigned to a regional entity such as a NAT gateway:

Set scope = REGION (required)

Leave the availabilityDomain parameter empty

Set lifetime = EPHEMERAL

To list the ephemeral public IPs assigned to private IPs:

Set scope = AVAILABILITY_DOMAIN (required)

Set the availabilityDomain parameter to AD-1 (required)

Set lifetime = EPHEMERAL

Note: An ephemeral public IP assigned to a private IP is always in the same availability domain and compartment as the private IP.

Request

Supported Media Types

• application/json

Query Parameters

• availabilityDomain: string
  The availability domain of the pod shape.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• lifetime: string
  A filter to return only public IPs that match given lifetime.

  Allowed Values: [ "EPHEMERAL", "RESERVED" ]
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: oracle.doceng.json.BetterJsonNull@2c07545f
• publicIpPoolId: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that belong to the given public IP pool.
• scope(required): string
  Whether the public IP is regional or specific to a particular availability domain. A regional (REGION) public IP exists within a region and is assigned to a regional entity such as a NatGateway or to a private IP in any availability domain in the region. Reserved public IPs have scope = REGION, as do ephemeral public IPs assigned to a regional entity. An AVAILABILITY_DOMAIN public IP exists within the availability domain of the entity it's assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN. Each Private Cloud Appliance has a single availability domain: AD-1.

  Allowed Values: [ "REGION", "AVAILABILITY_DOMAIN" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list is being retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object PublicIp
  A public IP is a conceptual term that refers to a public IP address and related properties. The publicIp object is the API representation of a public IP. There are two types of public IPs: 1. Ephemeral 2. Reserved

{
    "items":{
        "$ref":"#/definitions/PublicIp"
    },
    "type":"array"
}

Nested Schema : PublicIp

Type: object

A public IP is a conceptual term that refers to a public IP address and related properties. The publicIp object is the API representation of a public IP. There are two types of public IPs: 1. Ephemeral 2. Reserved

Show Source

• assignedEntityId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the entity the public IP is assigned to, or in the process of being assigned to.
• assignedEntityType: string
  Allowed Values: [ "PRIVATE_IP", "NAT_GATEWAY" ]

  The type of entity the public IP is assigned to, or in the process of being assigned to.
• availabilityDomain: string
  Minimum Length: 1

  Maximum Length: 255

  The public IP's availability domain. This property is set only for ephemeral public IPs that are assigned to a private IP (when the scope of the public IP is set to AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP. Example: AD-1
• compartmentId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the public IP. For an ephemeral public IP, this is the compartment of its assigned entity (which can be a private IP or a regional entity such as a NAT gateway). For a reserved public IP that is currently assigned, its compartment can be different from the assigned private IP's.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}
• id: string
  Minimum Length: 1

  Maximum Length: 255

  The public IP's OCID.
• ipAddress: string
  The public IP address of the publicIp object. Example: 203.0.113.2
• lifecycleState: string
  Allowed Values: [ "PROVISIONING", "AVAILABLE", "ASSIGNING", "ASSIGNED", "UNASSIGNING", "UNASSIGNED", "TERMINATING", "TERMINATED" ]

  The public IP's current state.
• lifetime: string
  Allowed Values: [ "EPHEMERAL", "RESERVED" ]

  Defines when the public IP is deleted and released back to the public IP pool. EPHEMERAL: The lifetime is tied to the lifetime of its assigned entity. An ephemeral public IP must always be assigned to an entity. If the assigned entity is a private IP, the ephemeral public IP is automatically deleted when the private IP is deleted, when the VNIC is terminated, or when the instance is terminated. If the assigned entity is a NatGateway, the ephemeral public IP is automatically deleted when the NAT gateway is terminated. RESERVED: You control the public IP's lifetime. You can delete a reserved public IP whenever you like. It does not need to be assigned to a private IP at all times.
• privateIpId: string
  Minimum Length: 1

  Maximum Length: 255

  Deprecated. Use assignedEntityId instead. The OCID of the private IP that the public IP is currently assigned to, or in the process of being assigned to. Note: This is null if the public IP is not assigned to a private IP, or is in the process of being assigned to one.
• publicIpPoolId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the pool object created in the current tenancy.
• scope: string
  Allowed Values: [ "REGION", "AVAILABILITY_DOMAIN" ]

  Whether the public IP is regional or specific to a particular availability domain. 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 and ephemeral public IPs assigned to a regional entity have scope = REGION. AVAILABILITY_DOMAIN - The public IP exists within the availability domain of the entity it's assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN.
• timeCreated: string(date-time)
  The date and time the public IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

{
    "description":"A public IP is a conceptual term that refers to a public IP address and related properties. The publicIp object is the API representation of a public IP. There are two types of public IPs: 1. Ephemeral 2. Reserved",
    "x-obmcs-splat":{
        "resourceKind":"public-ip",
        "adLocality":"regional",
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"PublicIp",
            "scope":"customer",
            "rvnFromHeader":true
        },
        "activeLifecycleStates":[
            "AVAILABLE",
            "ASSIGNED",
            "UNASSIGNED"
        ],
        "deletedLifecycleStates":[
            "TERMINATED"
        ],
        "getOperationId":"GetPublicIp",
        "listResourcesOperationId":"ListPublicIps",
        "ocidEntityType":"publicip"
    },
    "properties":{
        "assignedEntityId":{
            "description":"The OCID of the entity the public IP is assigned to, or in the process of being assigned to.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "assignedEntityType":{
            "description":"The type of entity the public IP is assigned to, or in the process of being assigned to.",
            "enum":[
                "PRIVATE_IP",
                "NAT_GATEWAY"
            ],
            "type":"string"
        },
        "availabilityDomain":{
            "description":"The public IP's availability domain. This property is set only for ephemeral public IPs that are assigned to a private IP (when the scope of the public IP is set to AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP. Example: AD-1 ",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "compartmentId":{
            "description":"The OCID of the compartment containing the public IP. For an ephemeral public IP, this is the compartment of its assigned entity (which can be a private IP or a regional entity such as a NAT gateway). For a reserved public IP that is currently assigned, its compartment can be different from the assigned private IP's.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. Only the String type is supported.",
                    "type":"object"
                }
            }
        },
        "displayName":{
            "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "id":{
            "description":"The public IP's OCID.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "ipAddress":{
            "description":"The public IP address of the publicIp object. Example: 203.0.113.2 ",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The public IP's current state.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "ASSIGNING",
                "ASSIGNED",
                "UNASSIGNING",
                "UNASSIGNED",
                "TERMINATING",
                "TERMINATED"
            ],
            "type":"string"
        },
        "lifetime":{
            "description":"Defines when the public IP is deleted and released back to the public IP pool. EPHEMERAL: The lifetime is tied to the lifetime of its assigned entity. An ephemeral public IP must always be assigned to an entity. If the assigned entity is a private IP, the ephemeral public IP is automatically deleted when the private IP is deleted, when the VNIC is terminated, or when the instance is terminated. If the assigned entity is a NatGateway, the ephemeral public IP is automatically deleted when the NAT gateway is terminated. RESERVED: You control the public IP's lifetime. You can delete a reserved public IP whenever you like. It does not need to be assigned to a private IP at all times.",
            "enum":[
                "EPHEMERAL",
                "RESERVED"
            ],
            "type":"string"
        },
        "privateIpId":{
            "description":"Deprecated. Use assignedEntityId instead. The OCID of the private IP that the public IP is currently assigned to, or in the process of being assigned to. Note: This is null if the public IP is not assigned to a private IP, or is in the process of being assigned to one.",
            "maxLength":"255",
            "minLength":"1",
            "type":"string"
        },
        "scope":{
            "description":"Whether the public IP is regional or specific to a particular availability domain. 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 and ephemeral public IPs assigned to a regional entity have scope = REGION. AVAILABILITY_DOMAIN - The public IP exists within the availability domain of the entity it's assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN.",
            "enum":[
                "REGION",
                "AVAILABILITY_DOMAIN"
            ],
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the public IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z ",
            "format":"date-time",
            "type":"string"
        },
        "publicIpPoolId":{
            "description":"The OCID of the pool object created in the current tenancy.",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        }
    },
    "type":"object"
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"Operations\": {\"CostCenter\": \"42\"}} ",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. Only the String type is supported.",
            "type":"object"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"Operations": {"CostCenter": "42"}}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {\"Department\": \"Finance\"} ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Example: {"Department": "Finance"}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {\"CostCenter\": \"42\"} ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. Only the String type is supported.",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: {"CostCenter": "42"}

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top