GET /ops/getserviceconfig
Description
This resource allows you retrieve the following configuration settings in the Gateway:
- Data persistence settings
- Trace levels
- Filter logging levels
- Message payload logging
The Data persistence settings specify whether inbound and outbound transactions, the circuit path, and message trace are recorded. These settings are set at the global level and maybe overwritten for each HTTP interface.
The Trace levels are set at the HTTP interface level and the process level.
Each filter is responsible for logging its own message. It is set by default at the Relative path/Web Service level, but can be overwritten by configuring different messages for different log levels.
Note that responses will generally need to be parsed in order to extract values from the results.
The response is a JSON array of API Server nodes, where each node will contain information on its processes. Each process will list its HTTP services that contain information on its ports, relative paths and WebServices.
API Server information will contain:
- name - name of the API Server
- global data persistence settings for
- recordInboundTransactions
- recordOutboundTransactions
- recordCircuitPath
- recordTrace
- process information
Process information will contain:
- name - name of the process
- HTTP Service information
HTTP Service nodes will contain information on:
- Ports
- Port
- Enabled
- Type
- Tracelevel
- Data persistence settings
- recordInboundTransactions
- recordOutboundTransactions
- recordCircuitPath
- recordTrace
- Relative paths or WebServices information will contain:
- uri
- Enabled
- Filter Logging levels
- LogFatal
- LogFailure
- LogSuccess
- Messge Payload logging
- payloadOnRequest
- payloadOnResponse
- payloadOnRemoteSend
- payloadOnRemoteReceive
- enableAccessLogging
Resource URL
http://localhost:8090/ops/getserviceconfig
Parameters
| format | mandatory | The format of the response data. json is currently the only supported format |
Response Codes
| Response Code | Description |
|---|---|
| 200 | Success |
Example Request
GET http://localhost:8090/ops/getserviceconfig
[
{
"name": "Vordel Gateway Configuration",
"recordInboundTransactions": true,
"recordOutboundTransactions": true,
"recordCircuitPath": true,
"recordTrace": true,
"processes": [
{
"name": "instance-1",
"traceLevel": "INFO",
"httpServices": [
{
"name": "API Manager Services",
"ports": [
{
"port": "8078",
"enable": true,
"type": "HTTPS",
"traceLevel": "INFO",
"useSystemSettings": true,
"recordInboundTransactions": true,
"recordOutboundTransactions": true,
"recordCircuitPath": true,
"recordTrace": true
}
],
"uris": [
{
"uri": "/",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
}
]
},
{
"name": "API Manager Images",
"ports": [
{
"port": "8077",
"enable": true,
"type": "HTTP",
"traceLevel": "INHERIT",
"useSystemSettings": true,
"recordInboundTransactions": true,
"recordOutboundTransactions": true,
"recordCircuitPath": true,
"recordTrace": true
}
]
},
{
"name": "API Manager Services",
"ports": [
{
"port": "8079",
"enable": true,
"type": "HTTPS",
"traceLevel": "INFO",
"useSystemSettings": true,
"recordInboundTransactions": true,
"recordOutboundTransactions": true,
"recordCircuitPath": true,
"recordTrace": true
}
],
"uris": [
{
"uri": "/api/reports",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/post/login",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/home",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
}
]
},
{
"name": "Sample Services",
"ports": [
{
"port": "8081",
"enable": false,
"type": "HTTP",
"traceLevel": "INHERIT",
"useSystemSettings": true,
"recordInboundTransactions": true,
"recordOutboundTransactions": true,
"recordCircuitPath": true,
"recordTrace": true
}
],
"uris": [
{
"uri": "/encryption",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/throttle",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/signatureverification",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/main/stockquote",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/rest2soap",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/stockquote/instance2",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/stockquote/instance1",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
}
]
},
{
"name": "Default Services",
"ports": [
{
"port": "8080",
"enable": true,
"type": "HTTP",
"traceLevel": "INHERIT",
"useSystemSettings": true,
"recordInboundTransactions": true,
"recordOutboundTransactions": true,
"recordCircuitPath": true,
"recordTrace": true
}
],
"uris": [
{
"uri": "/",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/healthcheck",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
}
]
},
{
"name": "OAuth 2.0 Services",
"ports": [
{
"port": "8089",
"enable": false,
"type": "HTTPS",
"traceLevel": "INHERIT",
"useSystemSettings": true,
"recordInboundTransactions": true,
"recordOutboundTransactions": true,
"recordCircuitPath": true,
"recordTrace": true
}
],
"uris": [
{
"uri": "/oauth/login",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/api/oauth/tokeninfo",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/api/oauth/protected",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/api/oauth/revoke",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/api/oauth/authorize/txn/",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/api/oauth/token",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
},
{
"uri": "/api/oauth/authorize",
"enable": true,
"logFatal": false,
"logFailure": true,
"logSuccess": false,
"payloadOnRequest": false,
"payloadOnResponse": false,
"payloadOnRemoteSend": false,
"payloadOnRemoteReceive": false,
"enableAccessLogging": false
}
]
}
]
}
]
}
]