ondemandscanning1 命令行界面（CLI）允许您在终端中方便地使用大多数Google按需扫描服务的功能。

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

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

有关按需扫描API的所有其他信息，请参阅官方文档网站。

安装和源代码

使用cargo通过以下方式安装命令行界面：

cargo install google-ondemandscanning1-cli

在GitHub上查找源代码。

用法

本文档是根据修订版20220228的按需扫描 API生成的。CLI版本为3.1.0。

ondemandscanning1 [options]
        projects
                locations-operations-cancel <name> [-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>]
                locations-operations-wait <name> [-p <v>]... [-o <out>]
                locations-scans-analyze-packages <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-scans-vulnerabilities-list <parent> [-p <v>]... [-o <out>]
  ondemandscanning1 --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文件中，文件名以ondemandscanning1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，用户将被要求授权。根据CLI的指示进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

使用--debug标志将在标准错误中打印使用Debug表示的错误。

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