该cloudkms1-beta1命令行接口（CLI）允许您从终端舒适地使用Google Cloud KMS服务的大多数功能。

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

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

有关Cloud KMS API的更多信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行接口：

cargo install google-cloudkms1_beta1-cli

在GitHub上查找源代码。

用法

此文档是从修订版20170515的Cloud KMS API生成的。CLI版本为5.0.4。

cloudkms1-beta1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-key-rings-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-destroy <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-get <name> [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-list <parent> [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-restore <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-decrypt <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-encrypt <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-get <name> [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-list <parent> [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-update-primary-version <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-get <name> [-p <v>]... [-o <out>]
                locations-key-rings-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-key-rings-list <parent> [-p <v>]... [-o <out>]
                locations-key-rings-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
  cloudkms1-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目录中存储所有持久数据，该目录以cloudkms1-beta1-为前缀的JSON文件。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，用户会被要求授权。按照CLI给出的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

带有--debug标志的代码会将错误以Debug表示法打印到标准错误。

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