Jump to

• Request
• Response
• Examples

View gateway node details

get

/apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}

Returns details for the {nodeId} node registered to the {gwId} gateway. The response also contains HATEOAS links to related operations.

Users requesting this resource must be assigned Plan Manger, API Manager or Gateway Manager role and the Manage Gateway or View all Details grants for the specified gateway.

Request

Supported Media Types

• application/json

Path Parameters

• gwId: string
  A unique ID referencing a specific gateway.
• nodeId: string
  A unique ID referencing a specific gateway node.

Query Parameters

• 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.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"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.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The gateway node's definition.

Body ()

Root Schema : GetNodeResponse

Match All

Show Source

• object ResourceLinksProperties
• Node

{
    "allOf":[
        {
            "$ref":"#/definitions/ResourceLinksProperties"
        },
        {
            "$ref":"#/definitions/Node"
        }
    ]
}

Nested Schema : ResourceLinksProperties

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : Node

Match All

Show Source

• object NodeId
• object NodeIdentity
• object NodeDef
• object NodeState
• object NodeMetadata

{
    "allOf":[
        {
            "$ref":"#/definitions/NodeId"
        },
        {
            "$ref":"#/definitions/NodeIdentity"
        },
        {
            "$ref":"#/definitions/NodeDef"
        },
        {
            "$ref":"#/definitions/NodeState"
        },
        {
            "$ref":"#/definitions/NodeMetadata"
        }
    ]
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

Nested Schema : NodeId

Type: object

Show Source

• id: string
  The gateway node's ID.

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The gateway node's ID."
        }
    }
}

Nested Schema : NodeIdentity

Type: object

Show Source

• name: string
  The gateway node's name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"The gateway node's name."
        }
    }
}

Nested Schema : NodeDef

Type: object

Show Source

• configuration(optional): object configuration
• description(optional): string
  The gateway node's description.
• info(optional): object info
• proxyUrls(optional): array proxyUrls
• releaseVersion(optional): string
  The gateway node's release version.
• urls(optional): array urls

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string",
            "description":"The gateway node's description."
        },
        "releaseVersion":{
            "type":"string",
            "description":"The gateway node's release version."
        },
        "urls":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "proxyUrls":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "configuration":{
            "type":"object",
            "properties":{
            }
        },
        "info":{
            "type":"object",
            "properties":{
            }
        }
    }
}

Nested Schema : NodeState

Type: object

Show Source

• state(optional): string
  The gateway node's state. Valid values are REQUESTING, ACTIVE, and REJECTED.
• stateComments(optional): string
  Comments regarding the gateway node's state.

{
    "type":"object",
    "properties":{
        "state":{
            "type":"string",
            "description":"The gateway node's state. Valid values are <code>REQUESTING</code>, <code>ACTIVE</code>, and <code>REJECTED</code>."
        },
        "stateComments":{
            "type":"string",
            "description":"Comments regarding the gateway node's state."
        }
    }
}

Nested Schema : NodeMetadata

Type: object

Show Source

• createdAt(optional): string
  The date and time the gateway node was registered.
• createdBy(optional): string
  The user who registered the gateway node.
• updatedAt(optional): string
  The date and time the gateway node was last updated.
• updatedBy(optional): string
  The user who last updated the gateway node.

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"The user who registered the gateway node."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the gateway node was registered."
        },
        "updatedBy":{
            "type":"string",
            "description":"The user who last updated the gateway node."
        },
        "updatedAt":{
            "type":"string",
            "description":"The date and time the gateway node was last updated."
        }
    }
}

Nested Schema : configuration

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : info

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : proxyUrls

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : urls

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to get details for a gateway node by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X PUT 
-H "Authorization: Bearer access_token"
https://example.com/apiplatform/management/v1/gateways/{gwId}/nodes/{nodeId}

• {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 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:01:35 GMT
Content-Length: 678
Content-Type: application/json
X-oracle-dms-ecid: 7d56ba46-299a-4fc9-8083-6e09cf042601-00004251
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 node details and HATEOAS links to related operations.

{
  "updatedBy": "apicsadmin",
  "contactedAt": "2017-03-29T06:04:15+0000",
  "configuration": {
    "pollingInterval": "2 minutes"
  },
  "description": "testGatewayNodeDescription",
  "createdAt": "2017-03-29T05:02:08+0000",
  "urls": [
    "http://example.com:8011",
    "https://example.com:9022"
  ],
  "proxyUrls": [
    "http://www-proxy.example.com:80",
    "https://www-proxy.example.com:80"
  ],
  "createdBy": "apicsadmin",
  "name": "MultiPolciesAPILCMNode",
  "links": [
    {
      "templated": "true",
      "method": "GET",
      "rel": "canonical",
      "href": "https://example.com:443/apiplatform/management/v1/gateways/105/nodes/105"
    },
    {
      "templated": "true",
      "method": "PUT",
      "rel": "edit",
      "href": "https://example.com:443/apiplatform/management/v1/gateways/105/nodes/105"
    },
    {
      "templated": "true",
      "method": "DELETE",
      "rel": "unregister",
      "href": "https://example.com:443/apiplatform/management/v1/gateways/105/nodes/105"
    }
  ],
  "id": "105",
  "state": "ACTIVE",
  "updatedAt": "2017-03-29T05:04:52+0000"
}

Back to Top