Jump to

• Request
• Response
• Examples

Get node status

get

/apiplatform/gatewaynode/v1/

Returns the status of the gateway node. This is the node's ping utility.

Any user can request this resource.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

The node's status.

Body ()

Returns UP if the node is up.

Root Schema : StatusDetails

Type: string

Returns UP if the node is up.

500 Response

Unexpected error.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

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"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

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

Back to Top

Examples

The following example shows how to retrieve the status of 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 GET 
-u apicsadmin:password
https://example.com/apiplatform/gatewaynode/v1/

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Fri, 30 Dec 2016 17:51:59 GMT
Transfer-Encoding: chunked
Content-Type: text/plain

Example of Response Body

The following example shows the contents of the response body in text/plain format, including the status of the gateway node.

Status: UP

Back to Top