该datacatalog1-beta1 命令行界面（CLI）允许您从终端舒适地使用Google数据目录服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以通过标志将其定向到文件，而不受shell功能的限制。错误将打印到标准错误，并导致程序退出码为非零。

如果请求数据结构，这些结构将以美化打印的JSON格式返回，以便作为其他工具的输入。

有关数据目录API的所有其他信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面

cargo install google-datacatalog1_beta1-cli

在GitHub上查找源代码。

用法

本文档是根据修订版20240222的数据目录API生成的。CLI的版本为5.0.4。

datacatalog1-beta1 [options]
        catalog
                search (-r <kv>)... [-p <v>]... [-o <out>]
        entries
                lookup [-p <v>]... [-o <out>]
        projects
                locations-entry-groups-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-delete <name> [-p <v>]... [-o <out>]
                locations-entry-groups-entries-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-delete <name> [-p <v>]... [-o <out>]
                locations-entry-groups-entries-get <name> [-p <v>]... [-o <out>]
                locations-entry-groups-entries-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-list <parent> [-p <v>]... [-o <out>]
                locations-entry-groups-entries-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-tags-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-tags-delete <name> [-p <v>]... [-o <out>]
                locations-entry-groups-entries-tags-list <parent> [-p <v>]... [-o <out>]
                locations-entry-groups-entries-tags-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-get <name> [-p <v>]... [-o <out>]
                locations-entry-groups-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-list <parent> [-p <v>]... [-o <out>]
                locations-entry-groups-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-tags-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-tags-delete <name> [-p <v>]... [-o <out>]
                locations-entry-groups-tags-list <parent> [-p <v>]... [-o <out>]
                locations-entry-groups-tags-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-tag-templates-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-tag-templates-delete <name> [-p <v>]... [-o <out>]
                locations-tag-templates-fields-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-tag-templates-fields-delete <name> [-p <v>]... [-o <out>]
                locations-tag-templates-fields-enum-values-rename <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-tag-templates-fields-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-tag-templates-fields-rename <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-tag-templates-get <name> [-p <v>]... [-o <out>]
                locations-tag-templates-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-tag-templates-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-tag-templates-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-tag-templates-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-delete <name> [-p <v>]... [-o <out>]
                locations-taxonomies-export <parent> [-p <v>]... [-o <out>]
                locations-taxonomies-get <name> [-p <v>]... [-o <out>]
                locations-taxonomies-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-list <parent> [-p <v>]... [-o <out>]
                locations-taxonomies-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-policy-tags-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-policy-tags-delete <name> [-p <v>]... [-o <out>]
                locations-taxonomies-policy-tags-get <name> [-p <v>]... [-o <out>]
                locations-taxonomies-policy-tags-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-policy-tags-list <parent> [-p <v>]... [-o <out>]
                locations-taxonomies-policy-tags-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-policy-tags-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-policy-tags-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-taxonomies-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  datacatalog1-beta1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将在~/.google-service-cli目录中存储所有持久数据，其中以datacatalog1-beta1-为前缀的JSON文件。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

以下段落提供了有关各种持久数据的更多信息。

身份验证

大多数API都需要用户对任何请求进行身份验证。如果是这种情况，则作用域确定授予的权限集合。这些的粒度通常不超过只读或完全访问。

如果未设置，系统将自动选择最小的可行范围，例如调用只读方法时，它只会请求只读范围。您可以使用 --scope 标志直接指定范围。所有适用范围均在相应方法的 CLI 文档中有记录。

首次使用范围时，用户会被要求授权。按照 CLI 提供的指示授权或拒绝。

如果用户验证了某个范围，相关信息将以 JSON 格式存储在配置目录中，例如 ~/.google-service-cli/datacatalog1-beta1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用 Google 服务，它需要使用 Google 开发者控制台进行注册。应用程序可能使用的 API 将逐一启用。大多数 API 可以免费使用，并设有每日配额。

为了在不强制用户注册自己的应用程序的情况下更方便地使用 CLI，CLI 配置了默认应用程序密钥。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过在此位置放置自己的密钥文件来解决这个问题：~/.google-service-cli/datacatalog1-beta1-secret.json，假设已为它启用了所需的 datacatalog API。此类密钥文件可以从 Google 开发者控制台 的 APIs & auth -> Credentials -> Download JSON 下载并直接使用。

有关如何设置 Google 项目和启用 API 的更多信息，请参阅 官方文档。

调试

尽管 CLI 尽力提供可用的错误消息，但有时可能希望知道导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以“原样”输出到标准错误来实现的。

使用 --debug 标志将错误打印到标准错误，使用 Debug 表示形式。

您可以考虑将标准错误重定向到文件以便于使用，例如 datacatalog1-beta1 --debug <resource> <method> [options] 2>debug.txt。