file1-beta1 命令行界面（CLI）允许您从终端舒适地使用大多数Google Cloud Filestore服务的功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-file1_beta1-cli

在GitHub上找到源代码。

用法

本文档是从修订版20240126的Cloud Filestore API生成的。CLI版本为5.0.4。

file1-beta1 [options]
        projects
                locations-backups-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-backups-delete <name> [-p <v>]... [-o <out>]
                locations-backups-get <name> [-p <v>]... [-o <out>]
                locations-backups-list <parent> [-p <v>]... [-o <out>]
                locations-backups-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-instances-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-delete <name> [-p <v>]... [-o <out>]
                locations-instances-get <name> [-p <v>]... [-o <out>]
                locations-instances-list <parent> [-p <v>]... [-o <out>]
                locations-instances-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-restore <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-revert <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-shares-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-shares-delete <name> [-p <v>]... [-o <out>]
                locations-instances-shares-get <name> [-p <v>]... [-o <out>]
                locations-instances-shares-list <parent> [-p <v>]... [-o <out>]
                locations-instances-shares-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-snapshots-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-snapshots-delete <name> [-p <v>]... [-o <out>]
                locations-instances-snapshots-get <name> [-p <v>]... [-o <out>]
                locations-instances-snapshots-list <parent> [-p <v>]... [-o <out>]
                locations-instances-snapshots-patch <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>]
  file1-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目录中，目录前缀为file1-beta1-的JSON文件中。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

当首次使用作用域时，系统会要求用户授权。按照CLI给出的指示授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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