该 servicedirectory1-beta1 命令行界面（CLI）允许您从终端舒适地使用 Google 服务目录（Google Service Directory）服务的大部分功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-servicedirectory1_beta1-cli

在 GitHub 上查找源代码。

用法

本文档是根据版本 20240226 的 服务目录 API 生成的。CLI 的版本为 5.0.4。

servicedirectory1-beta1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-namespaces-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-delete <name> [-p <v>]... [-o <out>]
                locations-namespaces-get <name> [-p <v>]... [-o <out>]
                locations-namespaces-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-list <parent> [-p <v>]... [-o <out>]
                locations-namespaces-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-delete <name> [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-delete <name> [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-get <name> [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-list <parent> [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-get <name> [-p <v>]... [-o <out>]
                locations-namespaces-services-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-list <parent> [-p <v>]... [-o <out>]
                locations-namespaces-services-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-resolve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-workloads-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-workloads-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-workloads-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  servicedirectory1-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 目录中的 JSON 文件中，文件名以 servicedirectory1-beta1- 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

您可以通过在此位置放置自己的密钥文件来解决这个问题：~/.google-service-cli/servicedirectory1-beta1-secret.json，前提是该应用程序已启用了所需的servicedirectory API。这样的密钥文件可以从Google开发者控制台在APIs & auth -> Credentials -> Download JSON处下载，并直接使用。

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

调试

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

--debug标志会将错误以Debug表示形式打印到标准错误。

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