该 connectors1 命令行界面（CLI）允许您从终端舒适地使用Google Connectors服务的几乎所有功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其直接重定向到文件，而无需考虑shell的能力。错误将打印到标准错误，并导致程序的退出代码不为零。

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-connectors1-cli

在GitHub上找到源代码。

用法

此文档是从修订版20240221的Connectors API生成的。CLI版本为5.0.4。

connectors1 [options]
        projects
                locations-connections-connection-schema-metadata-get-action <name> [-p <v>]... [-o <out>]
                locations-connections-connection-schema-metadata-get-entity-type <name> [-p <v>]... [-o <out>]
                locations-connections-connection-schema-metadata-list-actions <name> [-p <v>]... [-o <out>]
                locations-connections-connection-schema-metadata-list-entity-types <name> [-p <v>]... [-o <out>]
                locations-connections-connection-schema-metadata-refresh <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connections-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connections-delete <name> [-p <v>]... [-o <out>]
                locations-connections-event-subscriptions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connections-event-subscriptions-delete <name> [-p <v>]... [-o <out>]
                locations-connections-event-subscriptions-get <name> [-p <v>]... [-o <out>]
                locations-connections-event-subscriptions-list <parent> [-p <v>]... [-o <out>]
                locations-connections-event-subscriptions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connections-event-subscriptions-retry <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connections-get <name> [-p <v>]... [-o <out>]
                locations-connections-get-connection-schema-metadata <name> [-p <v>]... [-o <out>]
                locations-connections-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-connections-list <parent> [-p <v>]... [-o <out>]
                locations-connections-listen-event <resource-path> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connections-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connections-repair-eventing <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connections-runtime-action-schemas-list <parent> [-p <v>]... [-o <out>]
                locations-connections-runtime-entity-schemas-list <parent> [-p <v>]... [-o <out>]
                locations-connections-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-connections-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-endpoint-attachments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-endpoint-attachments-delete <name> [-p <v>]... [-o <out>]
                locations-endpoint-attachments-get <name> [-p <v>]... [-o <out>]
                locations-endpoint-attachments-list <parent> [-p <v>]... [-o <out>]
                locations-endpoint-attachments-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-get-regional-settings <name> [-p <v>]... [-o <out>]
                locations-get-runtime-config <name> [-p <v>]... [-o <out>]
                locations-global-custom-connectors-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-custom-connectors-custom-connector-versions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-custom-connectors-custom-connector-versions-delete <name> [-p <v>]... [-o <out>]
                locations-global-custom-connectors-custom-connector-versions-get <name> [-p <v>]... [-o <out>]
                locations-global-custom-connectors-custom-connector-versions-list <parent> [-p <v>]... [-o <out>]
                locations-global-custom-connectors-custom-connector-versions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-custom-connectors-delete <name> [-p <v>]... [-o <out>]
                locations-global-custom-connectors-get <name> [-p <v>]... [-o <out>]
                locations-global-custom-connectors-list <parent> [-p <v>]... [-o <out>]
                locations-global-custom-connectors-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-get-settings <name> [-p <v>]... [-o <out>]
                locations-global-managed-zones-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-managed-zones-delete <name> [-p <v>]... [-o <out>]
                locations-global-managed-zones-get <name> [-p <v>]... [-o <out>]
                locations-global-managed-zones-list <parent> [-p <v>]... [-o <out>]
                locations-global-managed-zones-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-global-update-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-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-providers-connectors-get <name> [-p <v>]... [-o <out>]
                locations-providers-connectors-list <parent> [-p <v>]... [-o <out>]
                locations-providers-connectors-versions-eventtypes-get <name> [-p <v>]... [-o <out>]
                locations-providers-connectors-versions-eventtypes-list <parent> [-p <v>]... [-o <out>]
                locations-providers-connectors-versions-get <name> [-p <v>]... [-o <out>]
                locations-providers-connectors-versions-list <parent> [-p <v>]... [-o <out>]
                locations-providers-get <name> [-p <v>]... [-o <out>]
                locations-providers-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-providers-list <parent> [-p <v>]... [-o <out>]
                locations-providers-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-providers-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-update-regional-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
  connectors1 --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文件中，文件名以connectors1-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，系统会请求用户授权。根据 CLI 的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

尽管 CLI 尽力提供可用的错误消息，但有时了解导致特定问题的确切原因可能很有用。这通过允许所有客户端-服务器通信直接输出到标准错误来实现。

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

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