5.4.6　IMクライアント一覧取得

機能

登録済みのIMクライアントIDの一覧を取得します。

マネージャーホストに対して，ユーザー独自のOSS，または，JP1/IM - Managerが提供するCloudWatch Logs/AzureMonitorとの連携ツールや下位マネージャーと連携する場合、IMクライアントシークレットを使用して，インテリジェント統合管理基盤と連携先との通信で認証を行います。

実行権限

次の権限が必要です。

JP1資源グループ：*
JP1権限レベル：JP1_Console_Admin

APIのバージョン

形式

リクエスト行

GET /application/component/apiVersion/secret/client/list httpVersion

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

なし

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

{
  "clientIds": [IMクライアントID,...]
}

ステータスコード

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

ステータスコード	メッセージ	説明
200	−	APIの処理が成功しました。
403	KAJY01000-E	認証に使用したユーザーの権限不足です。
500	KAJY68009-E	DBアクセスエラー

戻り値

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

メンバー名	データ型	説明
clientIds	string[]	IMクライアントシークレットを識別するIDの配列

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

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

使用例

APIの使用例を次に示します。

リクエスト：

GET http://immhost01:20703/im/api/v1/secret/client/list

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

レスポンス：

< HTTP/1.1 200 OK
< Content-Type: application/json
{
    "clientIds": [ "clientid1", "clientid2" ]
}

ページの先頭へ

5.4.6 IMクライアント一覧取得

5.4.6　IMクライアント一覧取得