Get gateway nodes
/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
- application/json
-
gwId: string
A unique ID referencing a specific gateway.
-
fields(optional): array
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. - links(optional): array
Response
- application/json
200 Response
object
-
count(optional):
integer(int32)
The number of items in this collection.
object
-
links(optional):
array links
Includes 'canonical'.
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
object
-
links(optional):
array links
Includes 'canonical'.
object
-
configuration(optional):
object configuration
-
description(optional):
string
The gateway node's description.
-
info(optional):
object info
-
proxyUrls(optional):
array proxyUrls
-
releaseVersion(optional):
string
The gateway node's release version.
-
urls(optional):
array urls
object
-
state(optional):
string
The gateway node's state. Valid values are
REQUESTING
,ACTIVE
, andREJECTED
. -
stateComments(optional):
string
Comments regarding the gateway node's state.
object
-
createdAt(optional):
string
The date and time the gateway node was registered.
-
createdBy(optional):
string
The user who registered the gateway node.
-
updatedAt(optional):
string
The date and time the gateway node was last updated.
-
updatedBy(optional):
string
The user who last updated the gateway node.
403 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
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 areREQUESTING
,ACTIVE
, andREJECTED
. -
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" } ] }