5.18.3　シークレットの一覧取得

機能

統合エージェント制御基盤で管理するシークレットの一覧を取得します。

実行権限

JP1_Console_Admin

APIのバージョン

形式

リクエスト行

POST /application/component/apiVersion/agents/secrets httpVersion

リクエストのヘッダー

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

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

リクエストのメッセージボディーは，JSONフォーマットで送信できます。

[
  "agenthost":"統合エージェントホスト名",
  "managerhost":"マネージャーホスト名"
]

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

シークレットの一覧を返却します。このときobfuscatedとsecretの値は空文字列となります。

{
    "secrets": [
        {
            "key": "キー1",
            "obfuscated": "",
            "secret": ""
        },
        {
            "key": "キー2",
            "obfuscated": "",
            "secret": ""
        },
        {
            "key": "キー3",
            "obfuscated": "",
            "secret": ""
        }
    ]
}

パラメーター

リクエストのメッセージボディーに指定するパラメーターを次に示します。

パラメーター	データ型	省略可否	説明
agenthost	string	不可	統合エージェントホスト名を1〜255バイトで指定します。
managerhost	string	不可	マネージャーホスト名を1〜255バイトで指定します。

ステータスコード

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

ステータスコード	出力されるメッセージ	説明
200	−	APIの処理が成功しました。
400	KAJY68209-E	リクエストパラメーターが不正です。
400	KAJY68205-E	リクエストに指定した統合エージェントホスト名または，マネージャーホスト名がJP1/IM - Managerが管理する構成に存在しませんログインユーザーにリクエストに指定した統合エージェントの参照・操作権限がありません
403	KAJY01000-E	認証に使用したユーザーの権限が不足しています。
500	KAJY00007-E	システムエラーが発生しました（ディスク不足，メモリー不足など）。
500	KAJY68203-E	指定された統合エージェントのマネージャーのインテリジェント統合管理基盤に接続できません。
500	KAJY68207-E	統合エージェント基盤の処理でエラーが発生しました。
500	KAJY68211-E	インテリジェント統合管理基盤の処理でエラーが発生しました。
500	KAJY68212-E	統合エージェント基盤に接続できません。
500	KAJY68501-E	マネージャーの統合エージェントホスト管理DBに接続できません。

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

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

戻り値

なし

使用例

リクエスト：

POST http://immhost01:20703/im/api/v1/agents/secrets

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

{
    "agenthost": "hostA",
    "managerhost": "hostB"
}

レスポンス：

省略

ページの先頭へ

5.18.3 シークレットの一覧取得

5.18.3　シークレットの一覧取得