Generate Gateway Node Install Properties template
/apiplatform/management/v1/gateways/{gwId}/nodes/form
Returns the install properties template for the {gwId}
gateway.
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.
Response
- application/json
200 Response
object
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 the form template for gateway node install properties for a {gwId}
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/form
-
{gwId}
is the unique of a gateway. To retrieve available gateway. see Get gateways.
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, 22 Mar 2017 09:43:13 GMT Content-Length: 785 Content-Type: text/html;charset=utf-8 X-oracle-dms-ecid: 49d14691-2176-4c99-aed3-38438604f528-00001e9d X-oracle-dms-rid: 0 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.
{ "managementServiceUrl": "http://example.com:7201", "logicalGatewayId": "100", }