1. REST API for the Management Service in Oracle API Platform Cloud Service
  2. Tasks
  3. Gateways
  4. Nodes

Get gateway nodes

get

/apiplatform/management/v1/gateways/{gwId}/nodes

Returns a collection of registered, requesting registration and rejected nodes for the {gwId} gateway.

The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned Plan Manager, API Manager or Gateway Manager role and the Manage Gateway or View all Details grants for the specified gateway.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Collection Format: csv
    Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values.
Back to Top

Response

Supported Media Types

200 Response

The collection of gateway nodes.
Body ()
Root Schema : GetNodesResponse
Match All
Show Source
Nested Schema : CollectionResponseFeature
Type: object
Show Source
Nested Schema : LinksResponseFeature
Type: object
Show Source
Nested Schema : GetNodesResponse-allOf[2]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : GetNodesItem
Match All
Show Source
Nested Schema : ResourceLinksProperties
Type: object
Show Source
Nested Schema : Node
Match All
Show Source
Nested Schema : NodeId
Type: object
Show Source
Nested Schema : NodeIdentity
Type: object
Show Source
Nested Schema : NodeDef
Type: object
Show Source
Nested Schema : NodeState
Type: object
Show Source
Nested Schema : NodeMetadata
Type: object
Show Source
Nested Schema : configuration
Type: object
Show Source
Nested Schema : info
Type: object
Show Source
Nested Schema : proxyUrls
Type: array
Show Source
Nested Schema : urls
Type: array
Show Source

403 Response

Forbidden.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source

500 Response

Unexpected error.
Body ()
Root Schema : Error
Type: object
Show Source
Nested Schema : errorDetails
Type: array
additional errors
Show Source
Back to Top

Examples

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

curl -i -X GET 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/gateways/{gwId}/nodes

{gwId} is the unique Id for a gateway. To retrieve available gateway Ids, see Get gateways.

You can pass the following optional field values in the fields query parameter, separated by commas, to include them in the response:

  • description: The description of the node.

  • urls: The load balancer URLs of the gateway.

  • configuration: The configuration of the gateway.

  • state: The gateway node's state. Valid values are REQUESTING, ACTIVE, and REJECTED.

  • stateComments: Comments regarding the gateway node's state.

  • createdAt: The date and time the gateway was created.

  • createdBy: The user who created the gateway.

  • updatedAt: The date and time the gateway was last updated.

  • updatedBy: The user who last updated the gateway.

The following example shows you how to include these fields in the response:

curl -i -X GET 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/gateways/{gwId}/nodes?urls,updatedBy

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Server: Oracle-Traffic-Director/12.2.1.0.0
Date: Mon, 02 Jan 2017 19:44:28 GMT
Content-length: 895
Content-type: application/json
X-oracle-dms-ecid: X0oX^0Y00000
X-oracle-dms-rid: 0:1
Via: 1.1 otd_opc-config
Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

Example of Response Body

The following example shows the contents of the response body in JSON format, including details for each node registered to the specified logical gateway and HATEOAS links for related operations.

{
    "offset": 0,
    "count": 1,
    "limit": 128,
    "hasMore": false,
    "links": [
        {
            "templated": "true",
            "method": "GET",
            "rel": "self",
            "href": "http://example.com:443/apiplatform/management/v1/gateways/100/nodes?offset=0=128"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "canonical",
            "href": "http://example.com:443/apiplatform/management/v1/gateways/100/nodes"
        },
        {
            "templated": "true",
            "method": "POST",
            "rel": "register",
            "href": "http://example.com:443/apiplatform/management/v1/gateways/100/nodes"
        },
        {
            "templated": "true",
            "method": "GET",
            "rel": "generateForm",
            "href": "http://example.com:443/apiplatform/management/v1/gateways/100/nodes/form"
        }
    ],
    "items": [
        {
            "updatedBy": "gateway-runtime-user",
            "contactedAt": "2018-02-14T03:38:36-0800",
            "configuration": {
                "pollingInterval": "5 seconds"
            },
            "createdAt": "2018-02-05T09:03:14-0800",
            "urls": [
                "http://example.com:8001",
                "https://example.com:7002"
            ],
            "proxyUrls": [
                "http://www-example.com:80",
                "https://www-example.oracle.com:80"
            ],
            "createdBy": "api-gateway-user",
            "name": "Production Gateway Node 1",
            "links": [
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "self",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100/nodes/100"
                },
                {
                    "templated": "true",
                    "method": "GET",
                    "rel": "canonical",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100/nodes/100"
                },
                {
                    "templated": "true",
                    "method": "PUT",
                    "rel": "edit",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100/nodes/100"
                },
                {
                    "templated": "true",
                    "method": "DELETE",
                    "rel": "unregister",
                    "href": "http://example.com:443/apiplatform/management/v1/gateways/100/nodes/100"
                }
            ],
            "state": "ACTIVE",
            "id": "100",
            "info": {
                "analyticsAgent": "v1.0 r11.0",
                "policySDK": "v8.0 r1",
                "coreEngine": "v7.0.0.0.0 r803",
                "gatewayController": "v1.0 r9.0"
            },
            "updatedAt": "2018-02-13T14:52:46-0800"
        }
    ]
}
Back to Top