Register a node to a gateway
/apiplatform/management/v1/gateways/{gwId}/nodes
Requests registration to a node to the {gwId}
gateway. The request must be approved or rejected.
Users requesting this resource must be assigned Gateway Manager role and must be issued the Manage Gateway for the specific gateway.
Request
- application/json
-
gwId: string
A unique ID referencing a specific gateway.
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
Response
- application/json
201 Response
400 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
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 register a node to a gateway by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X POST
-H "Authorization: Bearer access_token"
-H "Content-Type:application/json"
-d @register-node.json
https://example.com/apiplatform/management/v1/gateways/{gwId}/nodes
{gwId}
is the unique of a gateway. To retrieve available gateway Ids, see Get gateways.
Example of Request Body
The following shows an example of the request body in JSON format, included with the request above in a file named register-node.json
.
{ "name": "gateway1", "description": "node description", "urls": ["http://example.com:8011"], "proxyUrls": ["http://proxy-us.example.com:80"] }
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: Thu, 16 Mar 2017 07:24:42 GMT Content-Length: 12 Content-Type: application/json X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-000267d0 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 ID of the node.
{ "id": "101" }