View gateway node details
/apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}
Returns details for the {nodeId}
node registered to the {gwId}
gateway. The response also contains HATEOAS links to related operations.
Users requesting this resource must be assigned Plan Manger, 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.
-
nodeId: string
A unique ID referencing a specific gateway node.
-
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
-
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
-
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 get details for a gateway node by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X PUT
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}
-
{gwId}
is the unique Id for a gateway. To retrieve available gateway Ids, see Get gateways. -
{nodeId}
is the unique Id for a node. To retrieve available node Ids, see Get gateway nodes.
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: Wed, 29 Jun 2016 16:01:35 GMT Content-Length: 678 Content-Type: application/json X-oracle-dms-ecid: 7d56ba46-299a-4fc9-8083-6e09cf042601-00004251 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc 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 node details and HATEOAS links to related operations.
{ "updatedBy": "apicsadmin", "contactedAt": "2017-03-29T06:04:15+0000", "configuration": { "pollingInterval": "2 minutes" }, "description": "testGatewayNodeDescription", "createdAt": "2017-03-29T05:02:08+0000", "urls": [ "http://example.com:8011", "https://example.com:9022" ], "proxyUrls": [ "http://www-proxy.example.com:80", "https://www-proxy.example.com:80" ], "createdBy": "apicsadmin", "name": "MultiPolciesAPILCMNode", "links": [ { "templated": "true", "method": "GET", "rel": "canonical", "href": "https://example.com:443/apiplatform/management/v1/gateways/105/nodes/105" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "https://example.com:443/apiplatform/management/v1/gateways/105/nodes/105" }, { "templated": "true", "method": "DELETE", "rel": "unregister", "href": "https://example.com:443/apiplatform/management/v1/gateways/105/nodes/105" } ], "id": "105", "state": "ACTIVE", "updatedAt": "2017-03-29T05:04:52+0000" }