dlp2-beta1 命令行界面（CLI）允许您从终端方便地使用Google DLP服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-dlp2_beta1-cli

在github上查找源代码。

用法

此文档是根据修订版20171205的DLP API生成的。CLI版本为5.0.4。

dlp2-beta1 [options]
        content
                deidentify (-r <kv>)... [-p <v>]... [-o <out>]
                inspect (-r <kv>)... [-p <v>]... [-o <out>]
                redact (-r <kv>)... [-p <v>]... [-o <out>]
        data-source
                analyze (-r <kv>)... [-p <v>]... [-o <out>]
        inspect
                operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-create (-r <kv>)... [-p <v>]... [-o <out>]
                operations-delete <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
                operations-list <name> [-p <v>]... [-o <out>]
                results-findings-list <name> [-p <v>]... [-o <out>]
        risk-analysis
                operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-delete <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
                operations-list <name> [-p <v>]... [-o <out>]
        root-categories
                info-types-list <category> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
  dlp2-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目录中，以dlp2-beta1-为前缀的JSON文件中。您可以使用--config-dir标志在每个调用上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会请求用户权限。按照命令行界面给出的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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