Update a gateway node state
/apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}/state
Updates the state of the {nodeId}
node registered to the {gwId}
gateway.
You can update the state from REQUESTING
to REJECTED
or ACTIVE
. When changing the state to REJECTED
, you can provide comments with the optional stateComments
attribute. Registration requests are approved or rejected depeding on the update you do.
Users requesting this resource must be assigned Gateway Manager role and the Manage Gateway grant 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.
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.
Response
- application/json
204 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 update the state of a node registered to a gateway by submitting a PUT request on the REST resource using cURL. For more information about cURL, see Use cURL
curl -i -X PUT -u apicsadmin:password -H "Content-Type:application/json" -d @node-state.json https://example.com/apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}/state
-
{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 Request Body
The following example shows the contents of the request body in JSON format, included with the request above in a file named node-state.json
.
{ "state":"ACTIVE", "stateComments":"Changed to Active" }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Fri, 17 Mar 2017 10:16:51 GMT X-oracle-dms-ecid: f102c33f-1c5b-4409-806d-03bf5706c492-0002b77d X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0