# ccictl explain
#### 操作背景
描述各种资源的字段和结构。
此命令描述与每个被支持的 API 资源关联的字段。 这些字段通过一个简单的 JSONPath 标识符进行识别：
```
<类型>.<字段名>[.<字段名>]
```
有关每个字段的信息是以 OpenAPI 格式从服务器中检索而来的。
使用 "ccictl api-resources" 获取受支持的资源的完整列表。
```
ccictl explain TYPE [--recursive=FALSE|TRUE] [--api-version=api-version-group] [-o|--output=plaintext|plaintext-openapiv2]
```
#### 示例
```
# 获取资源及其字段的文档
ccictl explain pods
# 获取资源中的所有字段
ccictl explain pods --recursive
# 获取被支持的 API 版本中 Deployment 的解释
ccictl explain deployments --api-version=apps/v1
# 获取资源中特定字段的文档
ccictl explain pods.spec.containers
```
#### 选项
```
--api-version string
```
使用资源的给定的 API 版本（组/版本）。
```
-h, --help
```
explain 操作的帮助命令。
```
--recursive
```
如果为真，递归打印所有字段的名称。否则，打印可用字段及其描述。
**ccictl选项亦可在子命令中生效，列表如下：**
[父命令ccictl选项列表](https://support.huaweicloud.com/devg-cci2/ccictl_01.html#ccictl_01__section188081236162119)