文档首页/ 云容器实例 CCI/ 开发指南/ 使用ccictl/ 命令行工具(ccictl)/ ccictl get
更新时间：2025-04-18 GMT+08:00
查看PDF
分享

ccictl get

操作背景

显示一个或多个资源。

打印一张包含与指定资源相关的最重要信息的表格。 您可以使用标签选择算符（--selector 标志）来过滤列表。 如果所请求的资源类型是命名空间作用域的，您只会看到当前命名空间中的结果， 除非您传递 --all-namespaces 参数。

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

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

ccictl 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]

示例

# 以 ps 输出格式列举所有 Pod
ccictl get pods

# 以 ps 输出格式列举所有 Pod，并提供更多信息（如PodIP）
ccictl get pods -o wide

# 以 ps 输出格式列举指定名称的单个 Pod
ccictl get po web

# 以 JSON 输出格式列举 "cci" API 组 "v2" 版本中的 Deployment
ccictl get deployments.v2.cci -o json

# 以 JSON 输出格式列举单个 Pod
ccictl get -o json pod web-pod-13je7

# 以 JSON 输出格式列举在 "pod.yaml" 中以 type 和 name 指定的 Pod
ccictl get -f pod.yaml -o json

# 仅返回指定 Pod 的 phase 值
ccictl get -o template pod/web-pod-13je7 --template={{.status.phase}}

# 在自定义列中列举资源信息
ccictl get pod test-pod -o custom-columns=CONTAINER:.spec.containers[0].name,IMAGE:.spec.containers[0].image

# 以 ps 输出格式同时列举所有 Deployment 和服务
ccictl get deploy,services

# 按类型和名称列举一个或多个资源
ccictl get deploy/web service/frontend pods/web-pod-13je7

# 列出 “backend” 命名空间中的所有 Deployment
ccictl get deployments --namespace backend

# 列出所有命名空间中存在的所有 Pod
ccictl get pods --all-namespaces

选项

-A, --all-namespaces

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

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

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

--chunk-size int     默认值：500

以块的形式返回大的列表，而不是一次性全部返回。设为 0 表示禁用。

--field-selector string

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

-f, --filename strings

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

-h, --help

get 操作的帮助命令。

--ignore-not-found

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

-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。参见自定义列 [自定义列]、golang 模板 [http://golang.org/pkg/text/template/#pkg-overview] 和 jsonpath 模板 [JSONPath支持]。

--output-watch-events

使用 --watch 或 --watch-only 标志时输出监视事件对象。现有对象被输出为初始的 ADDED 事件。

--raw string

向服务器发送请求所用的原始 URI。使用 cliconfig 文件中指定的传输方式。

-R, --recursive

递归处理在 -f、--filename 中给出的目录。当您想要管理位于同一目录中的相关清单时很有用。

-l, --selector string

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

--server-print     默认值：true

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

--show-kind

如果存在此标志，则列举所请求对象的资源类型。

--show-labels

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

--sort-by string

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

--template string

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

-w, --watch

列举/获取请求的对象后，监视其变化。

--watch-only

监视所请求对象的变化，而不先列举/获取对象。

ccictl选项亦可在子命令中生效，列表如下：

父命令ccictl选项列表