JSONPath 支持

Kubectl 支持 JSONPath 模板。

JSONPath 模板由用花括号 {} 括起来的 JSONPath 表达式组成。Kubectl 使用 JSONPath 表达式来过滤 JSON 对象中的特定字段并格式化输出。除了原始 JSONPath 模板语法之外，以下函数和语法是有效的

在 JSONPath 表达式中使用双引号引用文本。
使用 range、end 运算符迭代列表。
使用负切片索引向后遍历列表。负索引不会“环绕”列表，只要 -index + listLength >= 0 即可。

注意

$ 运算符是可选的，因为默认情况下表达式始终从根对象开始。
结果对象以其 String() 函数打印。

给定 JSON 输入

{
  "kind": "List",
  "items":[
    {
      "kind":"None",
      "metadata":{
        "name":"127.0.0.1",
        "labels":{
          "kubernetes.io/hostname":"127.0.0.1"
        }
      },
      "status":{
        "capacity":{"cpu":"4"},
        "addresses":[{"type": "LegacyHostIP", "address":"127.0.0.1"}]
      }
    },
    {
      "kind":"None",
      "metadata":{"name":"127.0.0.2"},
      "status":{
        "capacity":{"cpu":"8"},
        "addresses":[
          {"type": "LegacyHostIP", "address":"127.0.0.2"},
          {"type": "another", "address":"127.0.0.3"}
        ]
      }
    }
  ],
  "users":[
    {
      "name": "myself",
      "user": {}
    },
    {
      "name": "e2e",
      "user": {"username": "admin", "password": "secret"}
    }
  ]
}

函数	描述	示例	结果
`text`	纯文本	`kind is {.kind}`	`kind is List`
`@`	当前对象	`{@}`	与输入相同
`.` 或 `[]`	子操作符	`{.kind}`、`{['kind']}` 或 `{['name\.type']}`	`List`
`..`	递归下降	`{..name}`	`127.0.0.1 127.0.0.2 myself e2e`
`*`	通配符。获取所有对象	`{.items[*].metadata.name}`	`[127.0.0.1 127.0.0.2]`
`[start:end:step]`	下标运算符	`{.users[0].name}`	`myself`
`[,]`	联合运算符	`{.items[*]['metadata.name', 'status.capacity']}`	`127.0.0.1 127.0.0.2 map[cpu:4] map[cpu:8]`
`?()`	过滤器	`{.users[?(@.name=="e2e")].user.password}`	`secret`
`range`、`end`	迭代列表	`{range .items[*]}[{.metadata.name}, {.status.capacity}] {end}`	`[127.0.0.1, map[cpu:4]] [127.0.0.2, map[cpu:8]]`
`''`	引用解释的字符串	`{range .items[*]}{.metadata.name}{'\t'}{end}`	`127.0.0.1 127.0.0.2`
`\`	转义终止字符	`{.items[0].metadata.labels.kubernetes\.io/hostname}`	`127.0.0.1`

使用 kubectl 和 JSONPath 表达式的示例

kubectl get pods -o json
kubectl get pods -o=jsonpath='{@}'
kubectl get pods -o=jsonpath='{.items[0]}'
kubectl get pods -o=jsonpath='{.items[0].metadata.name}'
kubectl get pods -o=jsonpath="{.items[*]['metadata.name', 'status.capacity']}"
kubectl get pods -o=jsonpath='{range .items[*]}{.metadata.name}{"\t"}{.status.startTime}{"\n"}{end}'
kubectl get pods -o=jsonpath='{.items[0].metadata.labels.kubernetes\.io/hostname}'

注意

在 Windows 上，您必须对包含空格的任何 JSONPath 模板进行双引号（而不是如上所示的 bash 的单引号）。反过来，这意味着您必须在模板中的任何文字周围使用单引号或转义的双引号。例如

kubectl get pods -o=jsonpath="{range .items[*]}{.metadata.name}{'\t'}{.status.startTime}{'\n'}{end}"
kubectl get pods -o=jsonpath="{range .items[*]}{.metadata.name}{\"\t\"}{.status.startTime}{\"\n\"}{end}"

注意

不支持 JSONPath 正则表达式。如果您想使用正则表达式匹配，可以使用 jq 等工具。

# kubectl does not support regular expressions for JSONpath output
# The following command does not work
kubectl get pods -o jsonpath='{.items[?(@.metadata.name=~/^test$/)].metadata.name}'

# The following command achieves the desired result
kubectl get pods -o json | jq -r '.items[] | select(.metadata.name | test("test-")).metadata.name'

上次修改时间：2023 年 7 月 28 日下午 10:47 PST：修复 JSONPath 支持页面中不一致的命令 (2987c60d92)

JSONPath 支持

注意

注意

注意

反馈