REST API for Oracle Cloud Infrastructure Compute Classic

Retrieve Details of a Private Gateway

get

/network/v1/privategateway/{name}

This endpoint is not available on Oracle Cloud Machine.

Retrieves details of the specified private gateway.

Required Role: To complete this task, you must have the Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types

application/oracle-compute-v3+json

Path Parameters

name: string

The three-part name of the object (/Compute-identity_domain/user/object).

Header Parameters

Cookie: string

The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.

Response

Supported Media Types

application/oracle-compute-v3+json

200 Response

OK. See Status Codes for information about other possible HTTP status codes.

Headers

set-cookie: string

The cookie value is returned if the session is extended

Root Schema : PrivateGateway-response

Type: object

Show Source

description(optional): string

Description of the object.
ipNetworks(optional): array ipNetworks

List of IP networks that is associated with the private gateway. When you set up FastConnect Classic private peering, you can directly access the instances on these IP networks from your premises without using NAT or IPSec VPN.
name(optional): string

The three-part name of the private gateway (/Compute-identity_domain/user/object).
tags(optional): array tags

Tags associated with the object.
uri(optional): string

Uniform Resource Identifier.

{
    "properties":{
        "description":{
            "type":"string",
            "description":"Description of the object."
        },
        "ipNetworks":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"List of IP networks that is associated with the private gateway. When you set up FastConnect Classic private peering, you can directly access the instances on these IP networks from your premises without using NAT or IPSec VPN."
        },
        "name":{
            "type":"string",
            "description":"The three-part name of the private gateway (<code>/Compute-<em>identity_domain</em>/<em>user</em>/<em>object</em></code>)."
        },
        "tags":{
            "items":{
                "type":"string"
            },
            "type":"array",
            "description":"Tags associated with the object."
        },
        "uri":{
            "type":"string",
            "description":"Uniform Resource Identifier."
        }
    }
}

Nested Schema : ipNetworks

Type: array

List of IP networks that is associated with the private gateway. When you set up FastConnect Classic private peering, you can directly access the instances on these IP networks from your premises without using NAT or IPSec VPN.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"List of IP networks that is associated with the private gateway. When you set up FastConnect Classic private peering, you can directly access the instances on these IP networks from your premises without using NAT or IPSec VPN."
}

Nested Schema : tags

Type: array

Tags associated with the object.

Show Source

Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array",
    "description":"Tags associated with the object."
}

Examples

cURL Command

The following example shows how to retrieve details of a private gateway by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Content-Type: application/oracle-compute-v3+json"
     -H "Accept: application/oracle-compute-v3+json"
        https://api-z999.compute.us0.oraclecloud.com/network/v1/privategateway/Compute-acme/jack.jones@example.com/privategateway1

COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.
api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.
acme and jack.jones@example.com are example values. Replace acme with the identity domain ID of your Compute Classic account, and jack.jones@example.com with your user name.

Example of Response Body

The following example shows the response body in JSON format.

{
  "name": "/Compute-acme/jack.jones@example.com/privategateway1",
  "uri": "https://api-z999.compute.us0.oraclecloud.com:443/network/v1/privategateway/Compute-acme/jack.jones@example.com/privategateway1",
  "description": "My first private gateway",
  "tags": null,
  "ipNetworks": [
    "/Compute-acme/jack.jones@example.com/ipnet2",
    "/Compute-acme/jack.jones@example.com/ipnet1"
  ]
}