kubectl get

Synopsis

顯示一個或多個資源。

列印指定資源最重要的資訊表格。您可以使用標籤選擇器和 --selector 標誌來過濾列表。如果所需的資源型別是名稱空間的,則在未指定任何名稱空間的情況下,您只能看到當前名稱空間中的結果。

透過將輸出指定為“template”併為 --template 標誌提供 Go 模板作為值,您可以過濾獲取資源的屬性。

使用 "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

Options

-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

如果設定為 true,則抑制特定不存在物件的 NotFound 錯誤。將此標誌與查詢資源集合的命令一起使用,在找不到任何資源時無效。

-k, --kustomize string

處理 kustomization 目錄。此標誌不能與 -f 或 -R 一起使用。

-L, --label-columns 字串

接受一個逗號分隔的標籤列表,這些標籤將顯示為列。名稱區分大小寫。您也可以使用多個標誌選項,如 -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.club.tw/docs/reference/kubectl/#custom-columns]、golang 模板 [https://golang.org.tw/pkg/text/template/#pkg-overview] 和 jsonpath 模板 [https://kubernetes.club.tw/docs/reference/kubectl/jsonpath/]。

--output-watch-events

使用 --watch 或 --watch-only 時輸出 watch 事件物件。現有物件將作為初始 ADDED 事件輸出。

--raw string

向伺服器請求的原始 URI。使用 kubeconfig 檔案指定的傳輸。

-R, --recursive

遞迴處理 -f, --filename 指定的目錄。當您想管理組織在同一目錄下的相關清單時很有用。

-l, --selector string

用於過濾的選擇器(標籤查詢),支援 '=', '==', '!=', 'in', 'notin'。(例如 -l key1=value1,key2=value2,key3 in (value3))。匹配的物件必須滿足所有指定的標籤約束。

--server-print     預設值: true

如果為 true,則讓伺服器返回相應的表格輸出。支援擴充套件 API 和 CRD。

--show-kind

如果存在,則列出請求物件(s)的資源型別。

--show-labels

列印時,顯示所有標籤作為最後一列(預設隱藏標籤列)

--show-managed-fields

如果為 true,則在以 JSON 或 YAML 格式列印物件時保留 managedFields。

--sort-by string

如果非空,則使用此欄位規範對列表型別進行排序。欄位規範表示為 JSONPath 表示式(例如:'{.metadata.name}')。此 JSONPath 表示式指定的 API 資源中的欄位必須是整數或字串。

--subresource string

如果指定,則獲取請求物件的子資源。

--template string

當 -o=go-template, -o=go-template-file 時使用的模板字串或模板檔案路徑。模板格式為 golang 模板 [https://golang.org.tw/pkg/text/template/#pkg-overview]。

-w, --watch

列出/獲取請求物件後,監視更改。

--watch-only

監視請求物件(s)的更改,而不先列出/獲取。

繼承的父選項

--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 上下文名稱

--disable-compression

如果為 true,則選擇退出所有到伺服器的請求的響應壓縮

--insecure-skip-tls-verify

如果為 true,則不會檢查伺服器證書的有效性。這將使您的 HTTPS 連線不安全。

--kubeconfig string

用於 CLI 請求的 kubeconfig 檔案路徑。

--kuberc string

用於首選項的 kuberc 檔案路徑。可以透過匯出 KUBECTL_KUBERC=false 功能標誌或關閉 KUBERC=off 功能來停用此功能。

--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 token

--user string

要使用的 kubeconfig 使用者名稱

--username string

API 伺服器基本身份驗證的使用者名稱

--version version[=true]

--version, --version=raw 列印版本資訊並退出;--version=vX.Y.Z... 設定報告的版本

--warnings-as-errors

將從伺服器收到的警告視為錯誤,並以非零退出程式碼退出。

另請參閱

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

本頁面是自動生成的。

如果你打算報告此頁面存在的問題,請在問題描述中提及此頁面是自動生成的。修復可能需要在 Kubernetes 專案的其他地方進行。

最後修改於 2025 年 9 月 4 日下午 3:30 PST: Update kubectl reference for v1.34 (bdc4bba2a5)