executeNodeAction
- Copy Page Tree
- Anonymous
For those unfamiliar with installing and managing Gateway Nodes, this operation is a robust operation that allows several maintenance options for managing your Gateway Nodes. For those familiar with managing Gateway Nodes, this operation is a glorified proxy for the APIGateway executable.
Environment/Instance Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| Oracle API Platform Account | FDOAP_CLOUD_ACCOUNT_CODE | Y | The Oracle API Platform cloud account to use for this operation. |
| Oracle Gateway Install Home | FDOAP_GATEWAY_INSTALL_HOME | Y | Absolute location of where to install the gateway node configuration. This is where the executable and libraries will be located. This should be empty prior to running this operation. Note that this is different compared to the 'nodeInstallDir' property in the gateway-props.json |
| Node Weblogic User | FDOAP_NODE_WL_ADMIN_USER | Y | Weblogic admin user to configure when creating the node. Oracle API Platform Nodes are weblogic servers and this is your admin user. |
| Node Weblogic Password | FDOAP_NODE_WL_ADMIN_PASSWORD | Y | Weblogic admin password to configure when creating the node. |
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| Gateway File | FDOAP_INP_GATEWAY_NODEPROPS_FILE | No | Gateway node properties file to use for execution. Relative to the artifacts directory. If left blank then the default of 'gateway-props.json' will be used in the Gateway Install Home. |
| Node Action | FDOAP_INP_NODE_ACTION | Yes | The node action to execute. This can be anything from 'start' or 'stop' the node to updating oauth credentials. |
Artifacts
This operation delegates the consume/produce artifacts decision to the workflow developer.
Endpoint Selection
This operation will select all available endpoints associated to the environment instance which have resource type of Oracle API Platform Node Server.
Endpoint Execution
This operation will select all available endpoints associated to the environment instance which have resource type of Oracle API Platform Node Server.
Special Considerations
Gateway File (gateway-props.json)
Checkout the installNode Special Considerations for information on the gateway-props.json
- style