Get gateway details
/apiplatform/management/v1/gateways/{gwId}
Returns details of the {gwId}
gateway. The response also contains HATEOAS links to related operations.
Users requesting this resource must be assigned Plan Manager, API Manager or Gateway Manager role and must be issued the Manage Gateway or View all Details grants for the specific gateway.
Request
- application/json
-
gwId: string
A unique ID referencing a specific gateway.
-
expand(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of expand values. -
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. - links(optional): array
Response
- application/json
200 Response
object
-
links(optional):
array links
Includes 'canonical'.
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
object
-
configuration(optional):
object configuration
-
description(optional):
string
The gateway's description.
-
firewall(optional):
object firewall
-
location(optional):
string
The gateway's location.
-
proxyUrls(optional):
array proxyUrls
-
releaseVersion(optional):
string
The gateway's release version. This property is used only at node registration time to seed the original release version of the node.
-
urls(optional):
array urls
object
-
createdAt(optional):
string
The date and time the gateway was created.
-
createdBy(optional):
string
The user who created the gateway.
-
updatedAt(optional):
string
The date time the gateway was last updated.
-
updatedBy(optional):
string
The user who last updated the gateway.
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 details for a 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}
{gwId}
is the unique of a gateway. To retrieve available gateway Ids, 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, 29 Jun 2016 16:47:09 GMT Content-Length: 1436 Content-Type: application/json X-oracle-dms-ecid: 7d56ba46-299a-4fc9-8083-6e09cf042601-000044ad 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 details for the gateway and HATEOAS links for related resources.
{ "createdAt": "2017-03-07T07:08:19-0800", "urls": [ "http://example.com:8001", "https://example.com:7002" ], "proxyUrls": [], "updatedBy": "apicsadmin", "firewall": { "maxUnboundedItems": "1024", "maxChildElementDepth": "1024", "maxItemValueLength": "102400", "maxMessageSize": "1024000" }, "createdBy": "api-gateway-user", "name": "Production Gateway", "description": "Production Gateway Description", "links": [ { "templated": "true", "method": "GET", "rel": "canonical", "href": "https://example.com:443/apiplatform/management/v1/gateways/100" }, { "templated": "true", "method": "GET", "rel": "preview", "href": "https://example.com:443/apiplatform/management/v1/gateways/100/preview" }, { "templated": "true", "method": "PUT", "rel": "edit", "href": "http://example.com.com:443/apiplatform/management/v1/gateways/100" }, { "templated": "true", "method": "PUT", "rel": "rename", "href": "https://example.com:443/apiplatform/management/v1/gateways/100/identity" }, { "templated": "true", "method": "GET", "rel": "nodes", "href": "https://example.com:443/apiplatform/management/v1/gateways/100/nodes" }, { "templated": "true", "method": "GET", "rel": "deployments", "href": "https://example.com:443/apiplatform/management/v1/gateways/100/deployments" }, { "templated": "true", "method": "GET", "rel": "grants", "href": "https://example.com:443/apiplatform/management/v1/gateways/100/grants" } ], "id": "100", "updatedAt": "2017-03-15T08:25:46-0700" }}