datacatalog1命令行界面（CLI）允许您在终端中轻松使用Google数据目录服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以使用标志将其定向到与shell功能无关的文件。错误将打印到标准错误，并导致程序退出代码不为零。

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-datacatalog1-cli

在github上找到源代码。

用法

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

datacatalog1 [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-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-list <parent> [-p <v>]... [-o <out>]
                locations-entry-groups-entries-modify-entry-contacts <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-modify-entry-overview <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-star <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-tags-reconcile <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-entry-groups-entries-unstar <name> (-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-operations-cancel <name> [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-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-replace <name> (-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 --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目录中的JSON文件中，文件名以datacatalog1-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，系统会要求用户授权。按照CLI给出的说明授予权限或拒绝。

如果作用域被用户验证，相关的信息将以JSON格式存储在配置目录中，例如：~/.google-service-cli/datacatalog1-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

为了使CLI更易于使用，而无需强制任何人为自己的应用程序注册，CLI附带了一个默认的应用程序密钥，相应地进行了配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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