cloudiot1 命令行界面（CLI）允许您在终端中舒适地使用大多数Google Cloud Iot服务功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-cloudiot1-cli

查找源代码 GitHub。

使用

此文档是从Cloud Iot API（修订版0）生成的。CLI版本为5.0.4。

cloudiot1 [options]
        projects
                locations-registries-bind-device-to-gateway <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-delete <name> [-p <v>]... [-o <out>]
                locations-registries-devices-config-versions-list <name> [-p <v>]... [-o <out>]
                locations-registries-devices-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-devices-delete <name> [-p <v>]... [-o <out>]
                locations-registries-devices-get <name> [-p <v>]... [-o <out>]
                locations-registries-devices-list <parent> [-p <v>]... [-o <out>]
                locations-registries-devices-modify-cloud-to-device-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-devices-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-devices-send-command-to-device <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-devices-states-list <name> [-p <v>]... [-o <out>]
                locations-registries-get <name> [-p <v>]... [-o <out>]
                locations-registries-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-groups-devices-list <parent> [-p <v>]... [-o <out>]
                locations-registries-groups-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-groups-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-groups-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-list <parent> [-p <v>]... [-o <out>]
                locations-registries-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-registries-unbind-device-from-gateway <parent> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudiot1 --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目录存储所有持久数据，并以cloudiot1-为前缀的JSON文件。您可以使用--config-dir标志在每次调用时更改配置目录。

有关各种持久数据的更多信息，请参阅以下段落。

身份验证

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

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

当第一次使用作用域时，系统会要求用户授权。按照CLI的指示授权或拒绝。

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

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

应用程序密钥

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

为了在不强迫任何人注册自己的应用程序的情况下更舒适地使用CLI，CLI自带一个默认应用程序密钥，并相应地配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

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

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

调试

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

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

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