cloudkms1 命令行界面 (CLI) 允许您从终端舒适地使用大多数Google Cloud KMS服务功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-cloudkms1-cli

在GitHub上找到源代码。

用法

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

cloudkms1 [options]
        projects
                locations-ekm-config-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-ekm-config-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-ekm-config-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-ekm-connections-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-ekm-connections-get <name> [-p <v>]... [-o <out>]
                locations-ekm-connections-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-ekm-connections-list <parent> [-p <v>]... [-o <out>]
                locations-ekm-connections-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-ekm-connections-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-ekm-connections-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-ekm-connections-verify-connectivity <name> [-p <v>]... [-o <out>]
                locations-generate-random-bytes <location> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-get-ekm-config <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-asymmetric-decrypt <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-asymmetric-sign <name> (-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-get-public-key <name> [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-import <parent> (-r <kv>)... [-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-mac-sign <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-mac-verify <name> (-r <kv>)... [-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-raw-decrypt <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-crypto-keys-crypto-key-versions-raw-encrypt <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-import-jobs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-import-jobs-get <name> [-p <v>]... [-o <out>]
                locations-key-rings-import-jobs-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-key-rings-import-jobs-list <parent> [-p <v>]... [-o <out>]
                locations-key-rings-import-jobs-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-key-rings-import-jobs-test-iam-permissions <resource> (-r <kv>)... [-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>]
                locations-update-ekm-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudkms1 --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 文件中，这些文件以 cloudkms1- 前缀开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。根据CLI提供的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

使用--debug标志将在标准错误上使用Debug表示形式打印错误。

您可以考虑将标准错误重定向到文件，以便于使用，例如cloudkms1 --debug <资源> <方法> [选项] 2>debug.txt。