5.19.1　下位マネージャー情報一覧取得

機能

統合マネージャー配下の拠点マネージャーまたは中継マネージャーの一覧を取得します。

実行権限

次の権限が必要です。

• JP1資源グループ：*

• JP1権限レベル：JP1_Console_Admin

APIのバージョン

v1

形式

リクエスト行

GET /application/component/apiVersion/subManagers httpVersion

リクエストのヘッダー

「5.2.3　リクエスト形式」のリクエストヘッダーに従います。

リクエストのメッセージボディー

なし

レスポンスのメッセージボディー

{
    "subManagers": [
         ホスト名,・・・
    ]
}

パラメーター

なし

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを，次の表に示します。

ステータスコード	出力されるメッセージ	説明
200	−	APIの処理が成功しました。
403	KAJY01000-E	認証に使用したユーザーの権限が不足しています。
500	KAJY68501-E	統合エージェントホスト管理DBに接続できません。

戻り値

ステータスコードが200の場合に，レスポンスボディーに次の情報を返却します。

メンバー名	データ型	省略可否	説明
subManagers	string[]	不可	下位マネージャーのホスト名の配列を指定します。ホスト名は1〜255バイトで指定します。 空配列は指定できません。

エラーメッセージの出力について

APIの実行時にエラーが発生した場合，APIのレスポンスにエラーメッセージの内容を含めて呼び出し元へ返却します。呼び出し元は受け取ったレスポンスの情報を使って，呼び出し元でメッセージの表示を行います。

使用例

リクエスト：

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

マネージャーホスト名：immhost01

レスポンス：

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

ページの先頭へ