kubectl get

概要

显示一个或多个资源。

打印指定资源的最重要信息的表格。 您可以使用标签选择器和 --selector 标志过滤列表。如果所需的资源类型是命名空间的，如果您不指定任何命名空间，您将只看到当前命名空间中的结果。

通过将输出指定为“template”并提供 Go 模板作为 --template 标志的值，您可以过滤获取的资源的属性。

使用 "kubectl api-resources" 获取支持的资源的完整列表。

kubectl get [(-o|--output=)json|yaml|name|go-template|go-template-file|template|templatefile|jsonpath|jsonpath-as-json|jsonpath-file|custom-columns|custom-columns-file|wide] (TYPE[.VERSION][.GROUP] [NAME | -l label] | TYPE[.VERSION][.GROUP]/NAME ...) [flags]

示例

  # List all pods in ps output format
  kubectl get pods
  
  # List all pods in ps output format with more information (such as node name)
  kubectl get pods -o wide
  
  # List a single replication controller with specified NAME in ps output format
  kubectl get replicationcontroller web
  
  # List deployments in JSON output format, in the "v1" version of the "apps" API group
  kubectl get deployments.v1.apps -o json
  
  # List a single pod in JSON output format
  kubectl get -o json pod web-pod-13je7
  
  # List a pod identified by type and name specified in "pod.yaml" in JSON output format
  kubectl get -f pod.yaml -o json
  
  # List resources from a directory with kustomization.yaml - e.g. dir/kustomization.yaml
  kubectl get -k dir/
  
  # Return only the phase value of the specified pod
  kubectl get -o template pod/web-pod-13je7 --template={{.status.phase}}
  
  # List resource information in custom columns
  kubectl get pod test-pod -o custom-columns=CONTAINER:.spec.containers[0].name,IMAGE:.spec.containers[0].image
  
  # List all replication controllers and services together in ps output format
  kubectl get rc,services
  
  # List one or more resources by their type and names
  kubectl get rc/web service/frontend pods/web-pod-13je7
  
  # List the 'status' subresource for a single pod
  kubectl get pod web-pod-13je7 --subresource status
  
  # List all deployments in namespace 'backend'
  kubectl get deployments.apps --namespace backend
  
  # List all pods existing in all namespaces
  kubectl get pods --all-namespaces

选项

-A, --all-namespaces

如果存在，则跨所有命名空间列出请求的对象。即使使用 --namespace 指定，当前上下文中的命名空间也会被忽略。

--allow-missing-template-keys     默认值: true

如果为 true，则当模板中缺少字段或映射键时，忽略模板中的任何错误。仅适用于 golang 和 jsonpath 输出格式。

--chunk-size int     默认值: 500

以块而不是一次返回大型列表。传递 0 以禁用。此标志为 beta 版，将来可能会更改。

--field-selector string

用于过滤的 选择器（字段查询），支持 '=', '==', 和 '!='。（例如 --field-selector key1=value1,key2=value2）。服务器仅支持每种类型的有限数量的字段查询。

-f, --filename strings

文件名、目录或 URL，用于标识要从服务器获取的资源。

-h, --help

get 的帮助信息

--ignore-not-found

如果请求的对象不存在，则命令将返回退出代码 0。

-k, --kustomize string

处理 kustomization 目录。此标志不能与 -f 或 -R 一起使用。

-L, --label-columns strings

接受以逗号分隔的标签列表，这些标签将作为列显示。名称区分大小写。您还可以使用多个标志选项，如 -L label1 -L label2...

--no-headers

使用默认或自定义列输出格式时，请勿打印标头（默认打印标头）。

-o, --output string

输出格式。以下之一：(json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide)。请参阅自定义列 [https://kubernetes.top/docs/reference/kubectl/#custom-columns]，golang 模板 [https://golang.ac.cn/pkg/text/template/#pkg-overview] 和 jsonpath 模板 [https://kubernetes.top/docs/reference/kubectl/jsonpath/]。

--output-watch-events

当使用 --watch 或 --watch-only 时，输出观察事件对象。现有对象作为初始 ADDED 事件输出。

--raw string

要从服务器请求的原始 URI。使用 kubeconfig 文件指定的传输方式。

-R, --recursive

递归地处理 -f、--filename 中使用的目录。当您要管理同一目录中组织的关联清单时很有用。

-l, --selector string

用于过滤的 选择器（标签查询），支持 '=', '==', 和 '!='。（例如 -l key1=value1,key2=value2）。匹配对象必须满足所有指定的标签约束。

--server-print     默认值: true

如果为 true，则让服务器返回适当的表格输出。支持扩展 API 和 CRD。

--show-kind

如果存在，则列出所请求对象的资源类型。

--show-labels

打印时，将所有标签显示为最后一列（默认隐藏标签列）

--show-managed-fields

如果为 true，则在以 JSON 或 YAML 格式打印对象时保留 managedFields。

--sort-by string

如果非空，则使用此字段规范对列表类型进行排序。字段规范表示为 JSONPath 表达式（例如 '{.metadata.name}'）。此 JSONPath 表达式指定的 API 资源中的字段必须是整数或字符串。

--subresource string

如果指定，则获取请求对象的子资源。此标志为 beta 版，将来可能会更改。

--template string

当 -o=go-template、-o=go-template-file 时，要使用的模板字符串或模板文件路径。模板格式为 golang 模板 [https://golang.ac.cn/pkg/text/template/#pkg-overview]。

-w, --watch

在列出/获取请求的对象后，监视更改。

--watch-only

监视对请求对象的更改，而不先列出/获取。

--as string

要模拟执行操作的用户名。用户可以是常规用户，也可以是命名空间中的服务帐户。

--as-group strings

要模拟执行操作的组，可以重复此标志以指定多个组。

--as-uid string

要模拟执行操作的 UID。

--cache-dir string     默认值: "$HOME/.kube/cache"

默认缓存目录

--certificate-authority string

证书颁发机构的证书文件路径

--client-certificate string

TLS 的客户端证书文件路径

--client-key string

TLS 的客户端密钥文件路径

--cluster string

要使用的 kubeconfig 集群的名称

--context string

要使用的 kubeconfig 上下文的名称

--default-not-ready-toleration-seconds int     默认值: 300

指示默认添加到每个尚未具有此类容忍度的 Pod 的 notReady:NoExecute 的容忍时间秒数。

--default-unreachable-toleration-seconds int     默认值: 300

指示默认添加到每个尚未具有此类容忍度的 Pod 的 unreachable:NoExecute 的容忍时间秒数。

--disable-compression

如果为 true，则选择退出对服务器的所有请求的响应压缩

--insecure-skip-tls-verify

如果为 true，则不会检查服务器的证书的有效性。这将使您的 HTTPS 连接不安全

--kubeconfig string

用于 CLI 请求的 kubeconfig 文件路径。

--match-server-version

要求服务器版本与客户端版本匹配

-n, --namespace string

如果存在，则表示此 CLI 请求的命名空间范围

--password string

用于对 API 服务器进行基本身份验证的密码

--profile string     默认值: "none"

要捕获的配置文件的名称。以下之一（none|cpu|heap|goroutine|threadcreate|block|mutex）

--profile-output string     默认值: "profile.pprof"

要将配置文件写入到的文件名

--request-timeout string     默认值: "0"

放弃单个服务器请求之前等待的时间长度。非零值应包含相应的时间单位（例如 1s、2m、3h）。值为零表示不超时请求。

-s, --server string

Kubernetes API 服务器的地址和端口

--storage-driver-buffer-duration duration     默认值: 1m0s

存储驱动程序中的写入将在此持续时间内缓冲，并作为单个事务提交到非内存后端

--storage-driver-db string     默认值: "cadvisor"

数据库名称

--storage-driver-host string     默认值: "localhost:8086"

数据库主机：端口

--storage-driver-password string     默认值: "root"

数据库密码

--storage-driver-secure

使用与数据库的安全连接

--storage-driver-table string     默认值: "stats"

表名

--storage-driver-user string     默认值: "root"

数据库用户名

--tls-server-name string

用于服务器证书验证的服务器名称。如果未提供，则使用用于联系服务器的主机名

--token string

用于向 API 服务器进行身份验证的 Bearer 令牌

--user string

要使用的 kubeconfig 用户的名称

--username string

用于对 API 服务器进行基本身份验证的用户名

--version version[=true]

--version，--version=raw 打印版本信息并退出；--version=vX.Y.Z... 设置报告的版本

--warnings-as-errors

将从服务器收到的警告视为错误，并以非零退出代码退出

另请参阅

  • kubectl - kubectl 控制 Kubernetes 集群管理器

此页面是自动生成的。

如果您计划报告此页面的问题，请在您的问题描述中提到该页面是自动生成的。修复可能需要在 Kubernetes 项目的其他地方进行。

上次修改时间：2024 年 12 月 12 日下午 2:44 PST：更新 v1.32 的 kubectl 参考 (5c2cfa02af)