docker secret inspect
読む時間の目安: 2 分
説明
1 つまたは複数の Secret(機密情報)の詳細情報を表示します。
API 1.25 以上
このコマンドを利用するには、クライアントとデーモンの API はともに、最低でも
1.25
である必要があります。
クライアント上においてdocker version
コマンドを実行して、クライアントとデーモンの API バージョンを確認してください。
Swarm このコマンドは Swarm オーケストレーターにおいて動作します。
利用方法
$ docker secret inspect [オプション] SECRET [SECRET...]
追加説明
指定する Secret(機密情報)の詳細を表示します。
デフォルトで JSON 配列による結果を返します。 フォーマットが指定された場合は、出力結果にそのテンプレートを適用します。
フォーマットの詳細は、Go 言語の text/template パッケージにおいて説明されています。
Secret の利用に関する詳細は Docker Secret を使った機密情報の管理 を参照してください。
メモ
これはクラスター管理コマンドであるため、Swarm のマネージャーノード上で実行する必要があります。 マネージャーノードとワーカーノードについては、本ドキュメントの Swarm モード を参照してください。
本コマンドの利用例については、以下に示す 利用例の節 を参照してください。
オプション
名前/省略形 | デフォルト | 説明 |
--format , -f |
Go 言語テンプレートを使って出力をフォーマットします。 | |
--pretty |
読みやすい書式で内容を出力します。 |
利用例
名前または ID 指定による Secret の詳細表示
Secret の詳細表示は、名前 または ID を指定します。
たとえば以下のような Secret があるとします。
$ docker secret ls
ID NAME CREATED UPDATED
eo7jnzguqgtpdah3cm5srfb97 my_secret 3 minutes ago 3 minutes ago
$ docker secret inspect secret.json
出力は JSON 形式であり、たとえば以下のようになります。
[
{
"ID": "eo7jnzguqgtpdah3cm5srfb97",
"Version": {
"Index": 17
},
"CreatedAt": "2017-03-24T08:15:09.735271783Z",
"UpdatedAt": "2017-03-24T08:15:09.735271783Z",
"Spec": {
"Name": "my_secret",
"Labels": {
"env": "dev",
"rev": "20170324"
}
}
}
]
フォーマット設定
--format オプションを使えば、Secret に関する特定の情報を出力することができます。 以下のコマンドは Secret の生成時刻を出力します。
$ docker secret inspect --format='{{.CreatedAt}}' eo7jnzguqgtpdah3cm5srfb97
2017-03-24 08:15:09.735271783 +0000 UTC
上位コマンド
コマンド | 説明 |
---|---|
docker secret | Docker Secret を管理します。 |
関連コマンド
コマンド | 説明 |
docker secret create | ファイルまたは標準入力から Secret(機密情報)を生成します。 |
docker secret inspect | 1 つまたは複数の Secret(機密情報)の詳細情報を表示します。 |
docker secret ls | Secret(機密情報)を一覧表示します。 |
docker secret rm | 1 つまたは複数の Secret(機密情報)を削除します。 |