5.18.4　シークレットの追加，更新，削除

機能

統合エージェント制御基盤で管理するシークレットの追加，更新，削除を実行します。

登録できるシークレットは1000件までです。

実行権限

JP1_Console_Admin

APIのバージョン

形式

リクエスト行

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

リクエストのヘッダー

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

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

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

追加または更新だけを実行する（削除は実行しない）場合

追加するシークレットをaddに記載します。

[
    "agenthost":"統合エージェントホスト名",
    "managerhost":"マネージャーホスト名",
    "add": {
        "secrets": [
            {
                "key": "キー1",
                "secret": "平文シークレット1"
            },
            {
                "key": "キー2",
                "secret": "平文シークレット2"
            },
            {
                "key": "キー3",
                "secret": "平文シークレット3"
            }
        ]
    }
}

削除だけを実行する（追加や変更は実行しない）場合

削除するシークレットをdeleteに記載します。

[
    "agenthost":"統合エージェントホスト名",
    "managerhost":"マネージャーホスト名",
    "delete": {
        "secrets": [
            {
                "key": "キー1",
            },
            {
                "key": "キー2",
            },
            {
                "key": "キー3",
            }
        ]
    }
}

追加や更新と削除を実行する場合

追加や更新するシークレットをaddに記載し，削除するシークレットをdeleteに記載します。

addとdeleteに同一のキーを指定した場合，addで指定した内容が適用されます。

[
    "agenthost":"統合エージェントホスト名",
    "managerhost":"マネージャーホスト名",
    "add": {
        "secrets": [
            {
                "key": "キー1",
                "secret": "平文シークレット1"
            },
            {
                "key": "キー2",
                "secret": "平文シークレット2"
            },
            {
                "key": "キー3",
                "secret": "平文シークレット3"
            }
        ]
    },
    "delete": {
        "secrets": [
            {
                "key": "キー1",
            },
            {
                "key": "キー2",
            },
            {
                "key": "キー3",
            }
        ]
    }
}

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

なし

パラメーター

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

パラメーター		データ型	省略可否	説明
agenthost		string	不可	統合エージェントホスト名を1〜255バイトで指定します。
managerhost		string	不可	マネージャーホスト名を1〜255バイトで指定します。
add		object	可	追加または更新するシークレットを指定します。追加または更新するシークレットがない場合は省略します。
	secrets	object[]	不可	追加または更新するシークレットを指定します。
	key	string	不可	キー名にシークレットキーを指定します。指定できる文字数は1〜1024文字で，指定できる文字はASCIIコード（0x20〜0x7e）です。それ以外はエラーとなります。
	secret	string	不可	シークレットを指定します。指定できる文字数は1〜1024文字で，指定できる文字はASCIIコード（0x20〜0x7e）です。それ以外はエラーとなります。
delete		object	可	削除するシークレットを指定します。削除するシークレットがない場合は省略します。
	secrets	object[]	不可	削除するシークレットを指定します。
	key	string	不可	キー名にシークレットキーを指定します。指定できる文字数は1〜1024文字で，指定できる文字はASCIIコード（0x20〜0x7e）です。それ以外はエラーとなります。

ステータスコード

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

ステータスコード	出力されるメッセージ	説明
200	−	APIの処理が成功しました。
400	KAJY68209-E	リクエストパラメーターが不正です。
400	KAJY68205-E	リクエストに指定した統合エージェントホスト名または，マネージャーホスト名がJP1/IM - Managerが管理する構成に存在しませんログインユーザーにリクエストに指定した統合エージェントの参照・操作権限がありません
403	KAJY01000-E	認証に使用したユーザーの権限が不足しています。
500	KAJY00007-E	システムエラーが発生しました（ディスク不足，メモリー不足など）。
500	KAJY02039-E	内部エラーが発生しました（APIの引数指定不正、環境不正など）。
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/change

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

{
    "agenthost": "hostA",
    "managerhost": "hostB",
    "add": {
      "secrets": [
        {
          "key": "key1",
          "secret": "secret1"
        },
        {
          "key": "key2",
          "secret": "secret2"
        }
      ]
    }
}

レスポンス：

省略

ページの先頭へ

5.18.4 シークレットの追加，更新，削除

5.18.4　シークレットの追加，更新，削除