|
| 1 | +--- |
| 2 | +title: JSONPathのサポート |
| 3 | +content_type: concept |
| 4 | +weight: 25 |
| 5 | +--- |
| 6 | + |
| 7 | +<!-- overview --> |
| 8 | +kubectlはJSONPathのテンプレートをサポートしています。 |
| 9 | + |
| 10 | +<!-- body --> |
| 11 | + |
| 12 | +JSONPathのテンプレートは、波括弧`{}`によって囲まれたJSONPathの式によって構成されています。 |
| 13 | +kubectlでは、JSONPathの式を使うことで、JSONオブジェクトの特定のフィールドをフィルターしたり、出力のフォーマットを変更することができます。 |
| 14 | +本来のJSONPathのテンプレートの構文に加え、以下の機能と構文が使えます: |
| 15 | + |
| 16 | +1. JSONPathの式の内部でテキストをクォートするために、ダブルクォーテーションを使用します。 |
| 17 | +2. リストを反復するために、`range`、`end`オペレーターを使用します。 |
| 18 | +3. リストを末尾側から参照するために、負の数のインデックスを使用します。負の数のインデックスはリストを「周回」せず、`-index + listLength >= 0`が満たされる限りにおいて有効になります。 |
| 19 | + |
| 20 | +{{< note >}} |
| 21 | + |
| 22 | +- 式は常にルートのオブジェクトから始まるので、`$`オペレーターの入力は任意になります。 |
| 23 | + |
| 24 | +- 結果のオブジェクトはString()関数を適用した形で表示されます。 |
| 25 | + |
| 26 | +{{< /note >}} |
| 27 | + |
| 28 | +以下のようなJSONの入力が与えられたとします。 |
| 29 | + |
| 30 | +```json |
| 31 | +{ |
| 32 | + "kind": "List", |
| 33 | + "items":[ |
| 34 | + { |
| 35 | + "kind":"None", |
| 36 | + "metadata":{"name":"127.0.0.1"}, |
| 37 | + "status":{ |
| 38 | + "capacity":{"cpu":"4"}, |
| 39 | + "addresses":[{"type": "LegacyHostIP", "address":"127.0.0.1"}] |
| 40 | + } |
| 41 | + }, |
| 42 | + { |
| 43 | + "kind":"None", |
| 44 | + "metadata":{"name":"127.0.0.2"}, |
| 45 | + "status":{ |
| 46 | + "capacity":{"cpu":"8"}, |
| 47 | + "addresses":[ |
| 48 | + {"type": "LegacyHostIP", "address":"127.0.0.2"}, |
| 49 | + {"type": "another", "address":"127.0.0.3"} |
| 50 | + ] |
| 51 | + } |
| 52 | + } |
| 53 | + ], |
| 54 | + "users":[ |
| 55 | + { |
| 56 | + "name": "myself", |
| 57 | + "user": {} |
| 58 | + }, |
| 59 | + { |
| 60 | + "name": "e2e", |
| 61 | + "user": {"username": "admin", "password": "secret"} |
| 62 | + } |
| 63 | + ] |
| 64 | +} |
| 65 | +``` |
| 66 | + |
| 67 | +機能 | 説明 | 例 | 結果 |
| 68 | +--------------------|---------------------------|-----------------------------------------------------------------|------------------ |
| 69 | +`text` | プレーンテキスト | `kind is {.kind}` | `kind is List` |
| 70 | +`@` | 現在のオブジェクト | `{@}` | 入力した値と同じ値 |
| 71 | +`.` or `[]` | 子要素 | `{.kind}`, `{['kind']}` or `{['name\.type']}` | `List` |
| 72 | +`..` | 子孫要素を再帰的に探す | `{..name}` | `127.0.0.1 127.0.0.2 myself e2e` |
| 73 | +`*` | ワイルドカード。すべてのオブジェクトを取得する | `{.items[*].metadata.name}` | `[127.0.0.1 127.0.0.2]` |
| 74 | +`[start:end:step]` | 添字 | `{.users[0].name}` | `myself` |
| 75 | +`[,]` | 和集合 | `{.items[*]['metadata.name', 'status.capacity']}` | `127.0.0.1 127.0.0.2 map[cpu:4] map[cpu:8]` |
| 76 | +`?()` | フィルター | `{.users[?(@.name=="e2e")].user.password}` | `secret` |
| 77 | +`range`, `end` | リストの反復 | `{range .items[*]}[{.metadata.name}, {.status.capacity}] {end}` | `[127.0.0.1, map[cpu:4]] [127.0.0.2, map[cpu:8]]` |
| 78 | +`''` | 解釈済みの文字列をクォートする | `{range .items[*]}{.metadata.name}{'\t'}{end}` | `127.0.0.1 127.0.0.2` |
| 79 | + |
| 80 | +`kubectl`とJSONPathの式を使った例: |
| 81 | + |
| 82 | +```shell |
| 83 | +kubectl get pods -o json |
| 84 | +kubectl get pods -o=jsonpath='{@}' |
| 85 | +kubectl get pods -o=jsonpath='{.items[0]}' |
| 86 | +kubectl get pods -o=jsonpath='{.items[0].metadata.name}' |
| 87 | +kubectl get pods -o=jsonpath="{.items[*]['metadata.name', 'status.capacity']}" |
| 88 | +kubectl get pods -o=jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.startTime}{"\n"}{end}' |
| 89 | +``` |
| 90 | + |
| 91 | +{{< note >}} |
| 92 | +Windowsでは、空白が含まれるJSONPathのテンプレートをクォートする場合は(上記のようにシングルクォーテーションを使うのではなく)、ダブルクォーテーションを使わなければなりません。 |
| 93 | +また、テンプレート内のリテラルをクォートする際には、シングルクォーテーションか、エスケープされたダブルクォーテーションを使わなければなりません。例えば: |
| 94 | + |
| 95 | +```cmd |
| 96 | +kubectl get pods -o=jsonpath="{range .items[*]}{.metadata.name}{'\t'}{.status.startTime}{'\n'}{end}" |
| 97 | +kubectl get pods -o=jsonpath="{range .items[*]}{.metadata.name}{\"\t\"}{.status.startTime}{\"\n\"}{end}" |
| 98 | +``` |
| 99 | +{{< /note >}} |
| 100 | + |
| 101 | +{{< note >}} |
| 102 | + |
| 103 | +JSONPathの正規表現はサポートされていません。正規表現を利用した検索を行いたい場合は、`jq`のようなツールを使ってください。 |
| 104 | + |
| 105 | +```shell |
| 106 | +# kubectlはJSONpathの出力として正規表現をサポートしていないので、以下のコマンドは動作しない |
| 107 | +kubectl get pods -o jsonpath='{.items[?(@.metadata.name=~/^test$/)].metadata.name}' |
| 108 | + |
| 109 | +# 上のコマンドに期待される結果が欲しい場合、以下のコマンドを使うとよい |
| 110 | +kubectl get pods -o json | jq -r '.items[] | select(.metadata.name | test("test-")).spec.containers[].image' |
| 111 | +``` |
| 112 | +{{< /note >}} |
0 commit comments