REST API for Oracle Private Cloud Appliance Compute Enclave

List NAT Gateways

get

/20160918/natGateways

List the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

Request

Supported Media Types

application/json

Query Parameters

compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment.
displayName: string

Minimum Length: 1

Maximum Length: 255

A filter to return only resources that match the entire display name given.
lifecycleState: string

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
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: 0
sortBy: string

The optional field to sort the results by.

Allowed Values: [ "TIMECREATED", "NAME" ]
sortOrder: string

The sort order to use, either ascending (ASC) or descending (DESC).

Default Value: ASC

Allowed Values: [ "ASC", "DESC" ]
vcnId: string

Minimum Length: 1

Maximum Length: 255

The OCID of the VCN.

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. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Root Schema : schema

Type: array

Show Source

Array of: object NatGateway

A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic.

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

Nested Schema : NatGateway

Type: object

A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic.

Show Source

backboneFailoverPolicy: string

Allowed Values: [ "FAILOVER_TO_INTERNET", "DO_NOT_FAILOVER_TO_INTERNET" ]

Set to `FAILOVER_TO_INTERNET` (the default) to allow the replication of customer data from flowing over public Internet,set to `DO_NOT_FAILOVER_TO_INTERNET` to prevent replication of customer data from flowing over public Internet.
blockTraffic(required): boolean

Default Value: false

Whether the NAT gateway blocks traffic through it. The default is false. Example: true
compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the compartment that contains the NAT gateway.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace.
displayName: string

Minimum Length: 1

Maximum Length: 255

A user-friendly name. Does not need to be unique, and it is 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(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the NAT gateway.
lifecycleState(required): string

Allowed Values: [ "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED" ]

The NAT gateway's current state.
natIp(required): string

Minimum Length: 1

Maximum Length: 255

The IP address associated with the NAT gateway.
publicIpId: string

Minimum Length: 1

Maximum Length: 255

The OCID of the public IP address associated with the NAT gateway.
routeTableId: string

Minimum Length: 1

Maximum Length: 255

The OCID of the route table used by the NAT gateway. If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.
timeCreated(required): string(date-time)

The date and time the NAT gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z
vcnId(required): string

Minimum Length: 1

Maximum Length: 255

The OCID of the VCN the NAT gateway belongs to.
zprTags: object zprTags

Additional Properties Allowed: additionalProperties

zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

{
    "x-obmcs-splat":{
        "resourceKind":"nat-gateway",
        "adLocality":"regional"
    },
    "description":"A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic.",
    "properties":{
        "compartmentId":{
            "description":"The OCID of the compartment that contains the NAT gateway.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.",
            "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 need to be unique, and it is 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"
            }
        },
        "zprTags":{
            "description":"zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well  Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}` ",
            "type":"object",
            "additionalProperties":{
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. ",
                "type":"object",
                "additionalProperties":{
                    "description":"The value of the tag. ",
                    "type":"object"
                }
            }
        },
        "id":{
            "description":"The OCID of the NAT gateway.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "blockTraffic":{
            "description":"Whether the NAT gateway blocks traffic through it. The default is false. Example: true ",
            "type":"boolean",
            "default":false
        },
        "lifecycleState":{
            "description":"The NAT gateway's current state.",
            "enum":[
                "PROVISIONING",
                "AVAILABLE",
                "TERMINATING",
                "TERMINATED"
            ],
            "type":"string"
        },
        "natIp":{
            "description":"The IP address associated with the NAT gateway.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the NAT gateway 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"
        },
        "vcnId":{
            "description":"The OCID of the VCN the NAT gateway belongs to.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "publicIpId":{
            "description":"The OCID of the public IP address associated with the NAT gateway.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "routeTableId":{
            "description":"The OCID of the route table used by the NAT gateway. If you don't specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN's default route table with the NAT gateway.",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "backboneFailoverPolicy":{
            "description":"Set to `FAILOVER_TO_INTERNET` (the default) to allow the replication of customer data from flowing  over public Internet,set to `DO_NOT_FAILOVER_TO_INTERNET` to prevent replication of customer data from  flowing over public Internet. ",
            "type":"string",
            "enum":[
                "FAILOVER_TO_INTERNET",
                "DO_NOT_FAILOVER_TO_INTERNET"
            ],
            "x-obmcs-top-level-enum":"#/definitions/BackboneFailoverPolicy"
        }
    },
    "required":[
        "compartmentId",
        "vcnId",
        "natIp",
        "id",
        "lifecycleState",
        "timeCreated",
        "blockTraffic"
    ],
    "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.",
    "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.

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 : zprTags

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.

{
    "description":"zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well  Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}` ",
    "type":"object",
    "additionalProperties":{
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. ",
        "type":"object",
        "additionalProperties":{
            "description":"The value of the tag. ",
            "type":"object"
        }
    }
}

zprTags for this resource. This is unique to ZPR, and extends the defined tags to include a mode keyword as well Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}`

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.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag.

{
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace. ",
    "type":"object",
    "additionalProperties":{
        "description":"The value of the tag. ",
        "type":"object"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace.

Nested Schema : additionalProperties

Type: object

The value of the tag.

400 Response

Bad Request

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
message(required): string

A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}