Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager Command, Definition File and API Reference


5.19.1 Retrieve lower manager info list

Description

Retrieves a list of base manager or relay manager under Integrated manager.

Execution permissions

Following permissions are required:

  • JP1 resource group: *

  • JP1 permission level: JP1_Console_Admin

API version

v1

Format
Request line
GET /application/component/apiVersion/subManagers httpVersion
Request header

Follow the request header in 5.2.3 Request format.

Request message body

None

Response message body
{
    "subManagers": [
         hostname, ...
    ]
}
Parameters

None

Status codes

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

Status code

Message

Description

200

--

API operation was successful.

403

KAJY01000-E

The permission of the user used for authentication is insufficient.

500

KAJY68501-E

Unable to connect to Unified Agent Host Management DB.

Return values

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

Member name

Data type

Optional

Description

subManagers

string[]

No

Specifies an array of host name for lower manager. Specify host name within the range of 1 to 255.

An empty array cannot be specified.

Error message output

API response, including the content of the error message, is returned to the caller when an execution error occurs. The caller displays message at the caller, using the information of the received response.

Examples
Request:
GET http://immhost01:20703/im/api/v1/subManagers

Manager host name: immhost01

Response:
< HTTP/1.1 200 OK
< Content-Type: application/json
{
    "subManagers":["hostA"]
}