5.8.3 IM management node status acquisition

Description

Gets the status information of all IM management nodes (management groups or management objects). If you specify IM management nodes as a parameter, the status information of only the specified IM management nodes is retrieved.

If the IM management node that the logged-in JP1 user has no permission to view is specified, zero-length array is returned.

Execution permissions

JP1_Console_Admin
JP1_Console_Operator
JP1_Console_User

API version

Format

Request line

POST /application/component/apiVersion/nodes/treeInfo/status httpVersion

Request message body

{
    "sid":[
    "IM-management-node-tree-SID"., ...
        ]
}

Response message body

{
    "simtData":[
    status-information-object,...
        ]
}

Parameters

sid

Specify the tree SID of the IM management node. You can get the status information of the specified IM management nodes. For details on the SID, see 7.1 SID.

This parameter accepts multiple values.

Omitting this parameter causes the status information of all accessible IM management nodes to be retrieved.

Status codes

The following table describes the status codes that are returned as a response to the request:

Status code	Message	Description
`200`	`OK`	The status of IM management nodes was retrieved successfully.
`400`	`Bad Request`	The request header is invalid.
`401`	`Unauthorized`	Authentication is required.
`403`	`Forbidden`	There is no execution permission.
`404`	`Not Found`	There is no permission to access the resource or the resource is not found.
`406`	`Not Acceptable`	An invalid `Accept` or `Accept-Language` header is specified.
`412`	`Precondition failed`	The server cannot be accessed.
`415`	`Unsupported media type`	An invalid `Content-Type` header is specified.
`500`	`Internal Server Error`	An error occurred with the server processing.

Return values

The following information is returned in the response body if the status code is 200:

No.	Member name	Data type	Description
1	`simtData`	object[]	Returns the retrieved status information as an array of the status information objects. A zero-length array is returned if no IM management node is found for the specified identifier or no IM management node is available.

No.

Member name

Data type

Description

simtData

object[]

Returns the retrieved status information as an array of the status information objects.

A zero-length array is returned if no IM management node is found for the specified identifier or no IM management node is available.

Definition format

{
  simtData: [
    {
      "sid": "SID-of-the-tree",
      "value":{
        "status":{"JP1EVENT": status-value}
      }
    },
    ...
  ]
}

Members

The following table describes the members:

No.	Member name	Data type	Description
1	`simtData`	array	An array that stores the status information
2	`sid`	string	The SID of the tree for the IM management node
3	`value`	array	An array that stores the status values
4	`status`	string	The status of the SID for the IM management node The type of the status (`JP1EVENT`) and a number that represents the status

Only simtData objects that are on the tree nodes whose status has been changed more than once due to JP1 events or higher-level propagation in the tree nodes specified by the request parameter will be returned.

The status values mean:

40: An Emergency-, Alert-, Critical-, or less-severe-level event occurred but was not processed.
30: An Error- or less-severe-level event occurred but was not processed.
20: A Warning- or less-severe-level event occurred but was not processed.
10: All the applicable severe events have been processed (or canceled or removed), and the system is in a healthy condition.

Examples

The following example uses the API to get the status of a management object, which is a jobnet with the SID of _JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1.

Note that the value of the Authorization header must be specified in a single line.

Request:

POST /im/api/v1/nodes/treeInfo/status HTTP/1.1
Authorization: Bearer xxxx
Accept-Language: ja
Content-Type: application/json
Accept: application/json
 
{
    "sid":[
    "_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1"
    ]
}

Response:

HTTP/1.1 200 OK
Cache-Control: no-store, no-cache, max-age=0
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Content-Type: application/json
 
{
    "simtData":[
        {
        "sid": "_ROOT_AllSystem",
        "value":{
        "status":{"JP1EVENT": 40}
        }
    ]
}

To Page Top